diff --git a/docs/Classes.html b/docs/Classes.html new file mode 100644 index 000000000..a27deddfd --- /dev/null +++ b/docs/Classes.html @@ -0,0 +1,1865 @@ + + + + Classes Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Classes

+

The following classes are available globally.

+ +
+
+
+
    +
  • +
    + + + + AdUnit + +
    +
    +
    +
    +
    +
    +

    Base class for ad units built for original type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class AdUnit : NSObject, DispatcherDelegate
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BannerAdUnit + +
    +
    +
    +
    +
    +
    +

    A class representing a banner ad unit for original type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class BannerAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + InstreamVideoAdUnit + +
    +
    +
    +
    +
    +
    +

    Represents an instream video ad unit for original type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + InterstitialAdUnit + +
    +
    +
    +
    +
    +
    +

    Represents an interstitial ad unit built for original type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BidInfo + +
    +
    +
    +
    +
    +
    +

    Contains information about bid.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+@objc(PBMBidInfo)
+public class BidInfo : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + PrebidAdUnit + +
    +
    +
    +
    +
    +
    +

    Multiformat ad unit. Built for original API.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class PrebidAdUnit : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + PrebidRequest + +
    +
    +
    +
    +
    +
    +

    Class that contains properties and methods to configure Prebid request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class PrebidRequest : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ContextSubType + +
    +
    +
    +
    +
    +
    +

    Native context subtype asset.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class ContextSubType : SingleContainerInt
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ContextType + +
    +
    +
    +
    +
    +
    +

    Native context type asset.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class ContextType : SingleContainerInt
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAd + +
    +
    +
    +
    +
    +
    +

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

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeAd : NSObject, CacheExpiryDelegate
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAdConfiguration + +
    +
    +
    +
    +
    +
    +

    Represents the configuration for a native ad, including markup and version information.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(PBMNativeAdConfiguration)
+@objcMembers
+public class NativeAdConfiguration : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAdMarkup + +
    +
    +
    +
    +
    +
    +

    Represents the markup for a native ad, including assets, tracking URLs, and other metadata.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeAdMarkup : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAdMarkupAsset + +
    +
    +
    +
    +
    +
    +

    Represents an asset in the native ad markup, which can be a title, image, data, or link.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeAdMarkupAsset : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAsset + +
    +
    +
    +
    +
    +
    +

    Represents a generic native ad asset which could be a title, image, or data.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class NativeAsset : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAssetTitle + +
    +
    +
    +
    +
    +
    +

    Represents a title asset in a native ad.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeAssetTitle : NativeAsset
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAssetImage + +
    +
    +
    +
    +
    +
    +

    Represents an image asset in a native ad.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeAssetImage : NativeAsset
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeAssetData + +
    +
    +
    +
    +
    +
    +

    Represents a data asset in a native ad.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeAssetData : NativeAsset
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ImageAsset + +
    +
    +
    +
    +
    +
    +

    Native image asset type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class ImageAsset : SingleContainerInt
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeData + +
    +
    +
    +
    +
    +
    +

    Class representing native data elements in the ad markup.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeData : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeEventTracker + +
    +
    +
    +
    +
    +
    +

    Class representing an event tracker for native ads.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class NativeEventTracker : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + EventType + +
    +
    +
    +
    +
    +
    +

    Class representing different event types.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class EventType : SingleContainerInt
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + EventTracking + +
    +
    +
    +
    +
    +
    +

    Native event tracking type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class EventTracking : SingleContainerInt
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Class representing a response for a native event tracker.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeEventTrackerResponse : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeImage + +
    +
    +
    +
    +
    +
    +

    Class representing an image asset in a native ad.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeImage : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeLink + +
    +
    +
    +
    +
    +
    +

    Class representing a link in a native ad.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeLink : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Represents a request object for native markup, including details about the ad’s context, placement, and supported features.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(PBMNativeMarkupRequestObject)
+@objcMembers
+public class NativeMarkupRequestObject : NSObject, NSCopying, PBMJsonCodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeRequest + +
    +
    +
    +
    +
    +
    +

    A class representing a native request for original type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class NativeRequest : AdUnit
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeTitle + +
    +
    +
    +
    +
    +
    +

    Represents the title element in a native ad, including optional text and length.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeTitle : NSObject, JsonDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + PlacementType + +
    +
    +
    +
    +
    +
    +

    Represents different types of placements for native ads.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class PlacementType : SingleContainerInt
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BannerParameters + +
    +
    +
    +
    +
    +
    +

    Describes an OpenRTB banner object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BannerParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + NativeParameters + +
    +
    +
    +
    +
    +
    +

    Represents parameters for a native ad request, including assets, event trackers, and configuration settings.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class NativeParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Signals + +
    +
    +
    +
    +
    +
    +

    A class containing constants related to OpenRTB signals.

    + +

    This class provides static constants and values representing different +API frameworks, playback methods, protocols, start delays, and video +placement types as defined in the OpenRTB specification.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class Signals : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SingleContainerInt + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class SingleContainerInt : NSObject, ExpressibleByIntegerLiteral
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + VideoParameters + +
    +
    +
    +
    +
    +
    +

    Describes an OpenRTB video object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class VideoParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + RewardedVideoAdUnit + +
    +
    +
    +
    +
    +
    +

    Represents an rewarded ad unit for original type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Utils + +
    +
    +
    +
    +
    +
    +

    A utility class for handling various ad-related operations and conversions.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class Utils : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + VideoAdUnit + +
    +
    +
    +
    +
    +
    +

    A deprecated class for handling video ad units.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This class is deprecated. Please, use BannerAdUnit with video adFormat.")
+public class VideoAdUnit : AdUnit
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A deprecated class representing a video interstitial ad unit. +This class is used to configure and manage video interstitial ads. It inherits from AdUnit and provides +specific settings for video ads including interstitial ad configuration and placement.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")
+public class VideoInterstitialAdUnit : AdUnit
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Prebid + +
    +
    +
    +
    +
    +
    +

    The Prebid class manages the configuration and initialization of the PrebidMobile SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class Prebid : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Targeting + +
    +
    +
    +
    +
    +
    +

    A class that manages targeting information for ads.

    + +

    This class provides properties and methods for setting and retrieving +user-specific targeting information, such as user ID, gender, and custom +data. It also includes details for OMID (Open Measurement Interface Definition) +partner and supports managing user identity links and custom extensions.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class Targeting : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ExternalUserId + +
    +
    +
    +
    +
    +
    +

    Defines the User Id Object from an External Thrid Party Source

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class ExternalUserId : NSObject, NSCoding, NSSecureCoding, JSONConvertible
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Host + +
    +
    +
    +
    +
    +
    +

    A singleton class that manages the Prebid server URL, including a custom URL.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class Host : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + AdFormat + +
    +
    +
    +
    +
    +
    +

    AdFormat is a class that represents different types of ad formats using an OptionSet. +The class also includes a deprecated display format for backward compatibility, marked with a deprecation message.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class AdFormat : NSObject, OptionSet
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A class representing the configuration for video controls in an ad. +This includes properties for video duration, mute status, and button positioning and visibility. +Configuration values can be initialized from bid response or set directly by the user.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(PBMVideoControlsConfiguration)
+@objcMembers
+public class VideoControlsConfiguration : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BannerView + +
    +
    +
    +
    +
    +
    +

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

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class BannerView: UIView,
+                         BannerAdLoaderDelegate,
+                         AdLoadFlowControllerDelegate,
+                         BannerEventInteractionDelegate,
+                         DisplayViewInteractionDelegate
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A base class for interstitial ad units.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class BaseInterstitialAdUnit :
+    NSObject,
+    PBMInterstitialAdLoaderDelegate,
+    AdLoadFlowControllerDelegate,
+    InterstitialControllerInteractionDelegate,
+    InterstitialEventInteractionDelegate,
+    BaseInterstitialAdUnitProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Represents an interstitial ad unit. Built for rendering type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class InterstitialRenderingAdUnit : BaseInterstitialAdUnit
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + RewardedAdUnit + +
    +
    +
    +
    +
    +
    +

    Represents an rewarded ad unit. Built for rendering type of integration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class RewardedAdUnit: BaseInterstitialAdUnit,
+                             RewardedEventInteractionDelegate
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + MediationBannerAdUnit + +
    +
    +
    +
    +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class MediationBannerAdUnit : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Base class for interstitial ads in Mediation API.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class MediationBaseInterstitialAdUnit : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class MediationInterstitialAdUnit : MediationBaseInterstitialAdUnit
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + MediationNativeAdUnit + +
    +
    +
    +
    +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class MediationNativeAdUnit : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class MediationRewardedAdUnit : MediationBaseInterstitialAdUnit
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/AdFormat.html b/docs/Classes/AdFormat.html new file mode 100644 index 000000000..29ef7ef79 --- /dev/null +++ b/docs/Classes/AdFormat.html @@ -0,0 +1,641 @@ + + + + AdFormat Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AdFormat

+
+
+ + 
@objcMembers
+public class AdFormat : NSObject, OptionSet
+ +
+
+

AdFormat is a class that represents different types of ad formats using an OptionSet. +The class also includes a deprecated display format for backward compatibility, marked with a deprecation message.

+ +
+
+
+
    +
  • +
    + + + + RawValue + +
    +
    +
    +
    +
    +
    +

    The underlying type of the raw value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public typealias RawValue = Int
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + rawValue + +
    +
    +
    +
    +
    +
    +

    The raw integer value representing the ad format.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let rawValue: Int
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stringEquivalent + +
    +
    +
    +
    +
    +
    +

    The string representation of the ad format.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var stringEquivalent: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes an AdFormat instance with a specified raw value and its string equivalent.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(rawValue: RawValue, stringEquivalent: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + rawValue + + +
    +

    The raw value representing the ad format.

    +
    +
    + + stringEquivalent + + +
    +

    A string equivalent of the ad format.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + init(rawValue:) + +
    +
    +
    +
    +
    +
    +

    Initializes an AdFormat instance with a specified raw value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(rawValue: RawValue)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The raw value representing the ad format.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + banner + +
    +
    +
    +
    +
    +
    +

    Represents a banner ad format.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let banner: AdFormat
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + video + +
    +
    +
    +
    +
    +
    +

    Represents a video ad format.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let video: AdFormat
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + native + +
    +
    +
    +
    +
    +
    +

    Represents a native ad format.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let native: AdFormat
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + display + +
    +
    +
    +
    +
    +
    +

    Represents a deprecated display ad format.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "Display ad format is deprecated. Please, use banner ad format instead.")
+public static let display: AdFormat
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + allCases + +
    +
    +
    +
    +
    +
    +

    An array containing all cases of ad formats, excluding deprecated ones.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static var allCases: [AdFormat] { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/AdUnit.html b/docs/Classes/AdUnit.html new file mode 100644 index 000000000..3f452f4b2 --- /dev/null +++ b/docs/Classes/AdUnit.html @@ -0,0 +1,1738 @@ + + + + AdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AdUnit

+
+
+ + 
@objcMembers
+public class AdUnit : NSObject, DispatcherDelegate
+ +
+
+

Base class for ad units built for original type of integration.

+ +
+
+
+
    +
  • +
    + + + + pbAdSlot + +
    +
    +
    +
    +
    +
    +

    ORTB: imp[].ext.data.adslot

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var pbAdSlot: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new AdUnit instance with the specified configuration ID, size, and ad formats.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configId: String, size: CGSize?, adFormats: Set<AdFormat>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configId + + +
    +

    The configuration ID for the ad unit.

    +
    +
    + + size + + +
    +

    The primary size of the ad. If nil, a default size of .zero is used.

    +
    +
    + + adFormats + + +
    +

    A set of ad formats supported by the ad unit.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Makes bid request and provides the result as a dictionary of key-value pairs.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "Deprecated. Use fetchDemand(completion: @escaping (_ bidInfo: BidInfo﹚ -> Void﹚ instead.")
+dynamic public func fetchDemand(completion: @escaping (_ result: ResultCode, _ kvResultDict: [String : String]?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A closure called with the result code and an optional dictionary of targeting keywords. + +

      +
    • result: The result code indicating the outcome of the demand fetch.
      • +
    • kvResultDict: A dictionary containing key-value pairs, or nil if no demand was fetched.
      • +

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Makes bid request and provides the result as a BidInfo object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    dynamic public func fetchDemand(completionBidInfo: @escaping (_ bidInfo: BidInfo) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completionBidInfo + + +
    +

    A closure called with a BidInfo object representing the fetched demand.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Makes bid request for a specific ad object and provides the result code. Setups targeting keywords into the adObject.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    dynamic public func fetchDemand(adObject: AnyObject, completion: @escaping (_ result: ResultCode) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + adObject + + +
    +

    The ad object for which demand is being fetched.

    +
    +
    + + completion + + +
    +

    A closure called with the result code indicating the outcome of the demand fetch.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

adunit ext data aka inventory data (imp[].ext.data) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & value for adunit context targeting +If the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & values for adunit context targeting +The values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context data keyword & values set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearContextData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all context data set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & values for adunit targeting +The values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateExtData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific ext data keyword & values set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all ext data set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

adunit ext keywords (imp[].ext.keywords) +

+
+
+
    +
  • +
    + + + + addContextKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context keyword from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeywords(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + removeExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method allows to remove specific keyword from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtKeywords() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtKeywords()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

App Content (app.content.data) +

+
+
+
    +
  • +
    + + + + setAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the app content object, replacing any existing content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setAppContent(_ appContentObject: PBMORTBAppContent)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + appContentObject + + +
    +

    The PBMORTBAppContent object representing the app’s content.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getAppContent() + +
    +
    +
    +
    +
    +
    +

    Retrieves the current app content object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getAppContent() -> PBMORTBAppContent?
    + +
    +
    +
    +

    Return Value

    +

    The current PBMORTBAppContent object, or nil if no content is set.

    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContent() + +
    +
    +
    +
    +
    +
    +

    Clears the current app content object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContent()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addAppContentData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of content data objects to the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addAppContentData(_ dataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObjects + + +
    +

    An array of PBMORTBContentData objects to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes a specific content data object from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeAppContentData(_ dataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObject + + +
    +

    The PBMORTBContentData object to remove.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContentData() + +
    +
    +
    +
    +
    +
    +

    Clears all content data objects from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContentData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

User Data (user.data) +

+
+
+
    +
  • +
    + + + + getUserData() + +
    +
    +
    +
    +
    +
    +

    Retrieves the current user data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getUserData() -> [PBMORTBContentData]?
    + +
    +
    +
    +

    Return Value

    +

    An array of PBMORTBContentData objects representing the user data, or nil if no data is available.

    +
    +
    +
    +
    • +
  • +
    + + + + addUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addUserData(_ userDataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObjects + + +
    +

    An array of PBMORTBContentData objects to add to the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a specific user data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeUserData(_ userDataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObject + + +
    +

    The PBMORTBContentData object to remove from the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearUserData() + +
    +
    +
    +
    +
    +
    +

    Clears all user data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearUserData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

GPID +

+
+
+
    +
  • +
    + + + + setGPID(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the GPID for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setGPID(_ gpid: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + gpid + + +
    +

    The GPID string to set. Can be nil to clear the GPID.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getGPID() + +
    +
    +
    +
    +
    +
    +

    Retrieves the current GPID for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getGPID() -> String?
    + +
    +
    +
    +

    Return Value

    +

    The GPID string, or nil if no GPID is set.

    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Global ORTBObject +

+
+
+
    +
  • +
    + + + + setOrtbConfig(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the OpenRTB configuration string for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setOrtbConfig(_ ortbObject: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + ortbObject + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getOrtbConfig() + +
    +
    +
    +
    +
    +
    +

    Retrieves the current OpenRTB configuration string for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getOrtbConfig() -> String?
    + +
    +
    +
    +

    Return Value

    +

    The OpenRTB configuration string, or nil if no configuration is set.

    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

others +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method allows to set the auto refresh period for the demand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setAutoRefreshMillis(time: Double)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + time + + +
    +

    refresh time interval

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + stopAutoRefresh() + +
    +
    +
    +
    +
    +
    +

    This method stops the auto refresh of demand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func stopAutoRefresh()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + resumeAutoRefresh() + +
    +
    +
    +
    +
    +
    +

    This method resumes the auto refresh of demand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func resumeAutoRefresh()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/BannerAdUnit.html b/docs/Classes/BannerAdUnit.html new file mode 100644 index 000000000..a7a2b7058 --- /dev/null +++ b/docs/Classes/BannerAdUnit.html @@ -0,0 +1,531 @@ + + + + BannerAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BannerAdUnit

+
+
+ + 
public class BannerAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
+ +
+
+

A class representing a banner ad unit for original type of integration.

+ +
+
+
+
    +
  • +
    + + + + parameters + +
    +
    +
    +
    +
    +
    +

    A deprecated property for banner ad parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This property is deprecated. Please, use bannerParameters instead.")
+public var parameters: BannerParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bannerParameters + +
    +
    +
    +
    +
    +
    +

    The banner ad parameters used to configure the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bannerParameters: BannerParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    The video ad parameters used to configure the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var videoParameters: VideoParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adFormats + +
    +
    +
    +
    +
    +
    +

    The set of ad formats for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var adFormats: Set<AdFormat> { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(configId:size:) + +
    +
    +
    +
    +
    +
    +

    Initializes a new BannerAdUnit with the specified configuration ID and size.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configId: String, size: CGSize)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configId + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + size + + +
    +

    The size of the banner ad unit.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Adds additional sizes to the banner ad unit’s configuration.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addAdditionalSize(sizes: [CGSize])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + sizes + + +
    +

    An array of CGSize objects representing additional sizes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/BannerParameters.html b/docs/Classes/BannerParameters.html new file mode 100644 index 000000000..929583369 --- /dev/null +++ b/docs/Classes/BannerParameters.html @@ -0,0 +1,467 @@ + + + + BannerParameters Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BannerParameters

+
+
+ + 
@objcMembers
+public class BannerParameters : NSObject
+ +
+
+

Describes an OpenRTB banner object

+ +
+
+
+
    +
  • +
    + + + + api + +
    +
    +
    +
    +
    +
    +

    List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var api: [Signals.Api]?
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Min width percentage value for interstitial

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var interstitialMinWidthPerc: Int?
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Min height percentage value for interstitial

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var interstitialMinHeightPerc: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adSizes + +
    +
    +
    +
    +
    +
    +

    Ad sizes of the ad

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var adSizes: [CGSize]?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Helpers +

+
+
+
    +
  • +
    + + + + rawAPI + +
    +
    +
    +
    +
    +
    +

    Helper for api values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var rawAPI: [Int]? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/BannerView.html b/docs/Classes/BannerView.html new file mode 100644 index 000000000..f1faa7e1f --- /dev/null +++ b/docs/Classes/BannerView.html @@ -0,0 +1,2564 @@ + + + + BannerView Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BannerView

+
+
+ + 
public class BannerView: UIView,
+                         BannerAdLoaderDelegate,
+                         AdLoadFlowControllerDelegate,
+                         BannerEventInteractionDelegate,
+                         DisplayViewInteractionDelegate
+ +
+
+

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

+ +
+
+
+
    +
  • +
    + + + + adUnitConfig + +
    +
    +
    +
    +
    +
    +

    The ad unit configuration.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let adUnitConfig: AdUnitConfig
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + eventHandler + +
    +
    +
    +
    +
    +
    +

    The event handler for banner view events.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let eventHandler: BannerEventHandler?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + bannerParameters + +
    +
    +
    +
    +
    +
    +

    Banner-specific parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var bannerParameters: BannerParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    Video-specific parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var videoParameters: VideoParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastBidResponse + +
    +
    +
    +
    +
    +
    +

    The last bid response received.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var lastBidResponse: BidResponse? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + configID + +
    +
    +
    +
    +
    +
    +

    ID of Stored Impression on the Prebid server

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var configID: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + refreshInterval + +
    +
    +
    +
    +
    +
    +

    The interval for refreshing the ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var refreshInterval: TimeInterval { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + additionalSizes + +
    +
    +
    +
    +
    +
    +

    Additional sizes for the ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var additionalSizes: [CGSize]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adFormat + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var adFormat: AdFormat { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adPosition + +
    +
    +
    +
    +
    +
    +

    The position of the ad on the screen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var adPosition: AdPosition { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ortbConfig + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var ortbConfig: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    ORTB configuration string.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public weak var delegate: BannerViewDelegate?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a new BannerView.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+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.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + +
    + + configID + + +
    +

    The configuration ID for the ad unit.

    +
    +
    + + eventHandler + + +
    +

    The event handler for the banner view.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+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

    + 
    @objc
+public func loadAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the stored auction response.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func setStoredAuctionResponse(storedAuction: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + storedAuction + + +
    +

    The stored auction response string.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + stopRefresh() + +
    +
    +
    +
    +
    +
    +

    Stops the auto-refresh of the ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func stopRefresh()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext Data (imp[].ext.data) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Adds context data for a specified key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+@objc
+public func addContextData(_ data: String, forKey key: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + data + + +
    +

    The data to add.

    +
    +
    + + key + + +
    +

    The key associated with the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates context data for a specified key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+@objc
+public func updateContextData(_ data: Set<String>, forKey key: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + data + + +
    +

    A set of data to update.

    +
    +
    + + key + + +
    +

    The key associated with the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes context data for a specified key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+@objc
+public func removeContextDate(forKey key: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + key + + +
    +

    The key associated with the data to remove.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearContextData() + +
    +
    +
    +
    +
    +
    +

    Clears all context data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+@objc
+public func clearContextData()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Adds ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addExtData(key: String, value: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The key for the data.

    +
    +
    + + value + + +
    +

    The value for the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func updateExtData(key: String, value: Set<String>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The key for the data.

    +
    +
    + + value + + +
    +

    The value for the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeExtData(forKey: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + key + + +
    +

    The key for the data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtData() + +
    +
    +
    +
    +
    +
    +

    Clears ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearExtData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext keywords (imp[].ext.keywords) +

+
+
+
    +
  • +
    + + + + addContextKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    Adds a context keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+@objc
+public func addContextKeyword(_ newElement: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElement + + +
    +

    The keyword to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Adds a set of context keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+@objc
+public func addContextKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElements + + +
    +

    A set of keywords to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes a context keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+@objc
+public func removeContextKeyword(_ element: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + element + + +
    +

    The keyword to remove.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Clears all context keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+@objc
+public func clearContextKeywords()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an extended keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addExtKeyword(_ newElement: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElement + + +
    +

    The keyword to be added.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeywords(_:) + +
    +
    +
    +
    +
    +
    +

    Adds multiple extended keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addExtKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElements + + +
    +

    A set of keywords to be added.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    Removes an extended keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeExtKeyword(_ element: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + element + + +
    +

    The keyword to be removed.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtKeywords() + +
    +
    +
    +
    +
    +
    +

    Clears all extended keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearExtKeywords()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

App Content (app.content.data) +

+
+
+
    +
  • +
    + + + + setAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the app content data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func setAppContent(_ appContent: PBMORTBAppContent)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + appContent + + +
    +

    The app content data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContent() + +
    +
    +
    +
    +
    +
    +

    Clears the app content data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearAppContent()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addAppContentData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds app content data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addAppContentData(_ dataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObjects + + +
    +

    The data objects to be added.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes an app content data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeAppContentDataObject(_ dataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObject + + +
    +

    The data object to be removed.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Clears all app content data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearAppContentDataObjects()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

User Data (user.data) +

+
+
+
    +
  • +
    + + + + addUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addUserData(_ userDataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObjects + + +
    +

    The user data objects to be added.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a user data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeUserData(_ userDataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObject + + +
    +

    The user data object to be removed.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearUserData() + +
    +
    +
    +
    +
    +
    +

    Clears all user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearUserData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

DisplayViewInteractionDelegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func trackImpression(forDisplayView: PBMDisplayView)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func viewControllerForModalPresentation(fromDisplayView: PBMDisplayView) -> UIViewController?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + didLeaveApp(from:) + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func didLeaveApp(from displayView: PBMDisplayView)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func willPresentModal(from displayView: PBMDisplayView)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func didDismissModal(from displayView: PBMDisplayView)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

BannerAdLoaderDelegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func bannerAdLoader(_ bannerAdLoader: PBMBannerAdLoader, loadedAdView adView: UIView, adSize: CGSize)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func bannerAdLoader(_ bannerAdLoader: PBMBannerAdLoader, createdDisplayView displayView: PBMDisplayView)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

PBMAdLoadFlowControllerDelegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowController(_ adLoadFlowController: PBMAdLoadFlowController, failedWithError error: Error?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowControllerWillSendBidRequest(_ adLoadFlowController: PBMAdLoadFlowController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowControllerWillRequestPrimaryAd(_ adLoadFlowController: PBMAdLoadFlowController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowControllerShouldContinue(_ adLoadFlowController: PBMAdLoadFlowController) -> Bool
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

BannerEventInteractionDelegate +

+
+
+
    +
  • +
    + + + + willPresentModal() + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func willPresentModal()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + didDismissModal() + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func didDismissModal()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + willLeaveApp() + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func willLeaveApp()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var viewControllerForPresentingModal: UIViewController? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/BaseInterstitialAdUnit.html b/docs/Classes/BaseInterstitialAdUnit.html new file mode 100644 index 000000000..89f5b02d2 --- /dev/null +++ b/docs/Classes/BaseInterstitialAdUnit.html @@ -0,0 +1,3118 @@ + + + + BaseInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BaseInterstitialAdUnit

+
+
+ + 
public class BaseInterstitialAdUnit :
+    NSObject,
+    PBMInterstitialAdLoaderDelegate,
+    AdLoadFlowControllerDelegate,
+    InterstitialControllerInteractionDelegate,
+    InterstitialEventInteractionDelegate,
+    BaseInterstitialAdUnitProtocol
+ +
+
+

A base class for interstitial ad units.

+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + bannerParameters + +
    +
    +
    +
    +
    +
    +

    The banner parameters used for configuring ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var bannerParameters: BannerParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    The video parameters used for configuring ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var videoParameters: VideoParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastBidResponse + +
    +
    +
    +
    +
    +
    +

    The last bid response received for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var lastBidResponse: BidResponse? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + configID + +
    +
    +
    +
    +
    +
    +

    The configuration ID for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var configID: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adFormats + +
    +
    +
    +
    +
    +
    +

    The set of ad formats supported by this ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var adFormats: Set<AdFormat> { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ortbConfig + +
    +
    +
    +
    +
    +
    +

    The ORTB (OpenRTB) configuration string for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var ortbConfig: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isReady + +
    +
    +
    +
    +
    +
    +

    A Boolean value indicating whether the ad unit is ready to be displayed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var isReady: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isMuted + +
    +
    +
    +
    +
    +
    +

    A Boolean value indicating whether the video controls are muted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var isMuted: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isSoundButtonVisible + +
    +
    +
    +
    +
    +
    +

    A Boolean value indicating whether the sound button is visible in the video controls.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var isSoundButtonVisible: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + closeButtonArea + +
    +
    +
    +
    +
    +
    +

    The area of the close button in the video controls as a percentage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var closeButtonArea: Double { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + closeButtonPosition + +
    +
    +
    +
    +
    +
    +

    The position of the close button in the video controls.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var closeButtonPosition: Position { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    A delegate for handling interactions with the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public weak var delegate: AnyObject?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adUnitConfig + +
    +
    +
    +
    +
    +
    +

    The configuration object for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let adUnitConfig: AdUnitConfig
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a new BaseInterstitialAdUnit with the specified configuration ID, minimum size percentage, and event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    required public init(configID: String,
+                     minSizePerc: NSValue?,
+                     eventHandler: AnyObject?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minSizePerc + + +
    +

    The minimum size percentage for the ad unit.

    +
    +
    + + eventHandler + + +
    +

    An optional event handler object for handling ad events.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new BaseInterstitialAdUnit with the specified configuration ID, minimum size percentage, and event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(configID: String,
+                        minSizePercentage: CGSize,
+                        eventHandler:AnyObject?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minSizePercentage + + +
    +

    The minimum size percentage for the ad unit.

    +
    +
    + + eventHandler + + +
    +

    An optional event handler object for handling ad events.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new BaseInterstitialAdUnit with the specified configuration ID and event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(configID: String,
+                        eventHandler:AnyObject?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + eventHandler + + +
    +

    An optional event handler object for handling ad events.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new BaseInterstitialAdUnit with the specified configuration ID and minimum size percentage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(configID: String,
+                        minSizePercentage:CGSize)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minSizePercentage + + +
    +

    The minimum size percentage for the ad unit.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + init(configID:) + +
    +
    +
    +
    +
    +
    +

    Initializes a new BaseInterstitialAdUnit with the specified configuration ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(configID: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + loadAd() + +
    +
    +
    +
    +
    +
    +

    Loads a new ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func loadAd()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + show(from:) + +
    +
    +
    +
    +
    +
    +

    Shows the ad from a specified view controller.

    +
    +

    Note

    + This method must be called on the main thread. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func show(from controller: UIViewController)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + controller + + +
    +

    The view controller from which the ad will be presented.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext Data (imp[].ext.data) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Adds context data for a specified key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+@objc
+public func addContextData(_ data: String, forKey key: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + data + + +
    +

    The data to add.

    +
    +
    + + key + + +
    +

    The key associated with the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates context data for a specified key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+@objc
+public func updateContextData(_ data: Set<String>, forKey key: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + data + + +
    +

    A set of data to update.

    +
    +
    + + key + + +
    +

    The key associated with the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes context data for a specified key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+@objc
+public func removeContextDate(forKey key: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + key + + +
    +

    The key associated with the data to remove.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearContextData() + +
    +
    +
    +
    +
    +
    +

    Clears all context data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+@objc
+public func clearContextData()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Adds ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addExtData(key: String, value: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The key for the data.

    +
    +
    + + value + + +
    +

    The value for the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func updateExtData(key: String, value: Set<String>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The key for the data.

    +
    +
    + + value + + +
    +

    The value for the data.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeExtData(forKey: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + key + + +
    +

    The key for the data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtData() + +
    +
    +
    +
    +
    +
    +

    Clears ext data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearExtData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext keywords (imp[].ext.keywords) +

+
+
+
    +
  • +
    + + + + addContextKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    Adds a context keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+@objc
+public func addContextKeyword(_ newElement: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElement + + +
    +

    The keyword to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Adds a set of context keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+@objc
+public func addContextKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElements + + +
    +

    A set of keywords to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes a context keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+@objc
+public func removeContextKeyword(_ element: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + element + + +
    +

    The keyword to remove.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Clears all context keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+@objc
+public func clearContextKeywords()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an extended keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addExtKeyword(_ newElement: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElement + + +
    +

    The keyword to be added.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeywords(_:) + +
    +
    +
    +
    +
    +
    +

    Adds multiple extended keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addExtKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + newElements + + +
    +

    A set of keywords to be added.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    Removes an extended keyword.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeExtKeyword(_ element: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + element + + +
    +

    The keyword to be removed.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtKeywords() + +
    +
    +
    +
    +
    +
    +

    Clears all extended keywords.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearExtKeywords()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

App Content (app.content.data) +

+
+
+
    +
  • +
    + + + + setAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the app content data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func setAppContent(_ appContent: PBMORTBAppContent)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + appContent + + +
    +

    The app content data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContent() + +
    +
    +
    +
    +
    +
    +

    Clears the app content data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearAppContent()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addAppContentData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds app content data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addAppContentData(_ dataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObjects + + +
    +

    The data objects to be added.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes an app content data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeAppContentDataObject(_ dataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObject + + +
    +

    The data object to be removed.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Clears all app content data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearAppContentDataObjects()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

User Data (user.data) +

+
+
+
    +
  • +
    + + + + addUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func addUserData(_ userDataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObjects + + +
    +

    The user data objects to be added.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a user data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func removeUserData(_ userDataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObject + + +
    +

    The user data object to be removed.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearUserData() + +
    +
    +
    +
    +
    +
    +

    Clears all user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clearUserData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

PBMInterstitialAdLoaderDelegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Internal delegate method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialAdLoader(_ interstitialAdLoader: PBMInterstitialAdLoader,
+                                 loadedAd showBlock: @escaping (UIViewController?) -> Void,
+                                 isReadyBlock: @escaping () -> Bool)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Internal delegate method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialAdLoader(_ interstitialAdLoader: PBMInterstitialAdLoader,
+                                 createdInterstitialController interstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + eventHandler + +
    +
    +
    +
    +
    +
    +

    The event handler for the interstitial events.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var eventHandler: Any?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

AdLoadFlowControllerDelegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Called when the ad load flow controller is about to send a bid request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowControllerWillSendBidRequest(_ adLoadFlowController: PBMAdLoadFlowController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad load flow controller is about to request the primary ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowControllerWillRequestPrimaryAd(_ adLoadFlowController: PBMAdLoadFlowController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called to determine if the ad load flow controller should continue with the current flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowControllerShouldContinue(_ adLoadFlowController: PBMAdLoadFlowController) -> Bool
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad load flow controller fails with an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adLoadFlowController(_ adLoadFlowController: PBMAdLoadFlowController, failedWithError error: Error?)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

InterstitialControllerInteractionDelegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Tracks an impression for the given interstitial controller.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func trackImpression(forInterstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad in the interstitial controller is clicked.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialControllerDidClickAd(_ interstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad in the interstitial controller is closed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialControllerDidCloseAd(_ interstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad in the interstitial controller causes the app to leave.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialControllerDidLeaveApp(_ interstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the interstitial controller displays an ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialControllerDidDisplay(_ interstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the interstitial controller completes the ad display.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func interstitialControllerDidComplete(_ interstitialController: InterstitialController)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Provides the view controller to use for modal presentation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func viewControllerForModalPresentation(fromInterstitialController: InterstitialController) -> UIViewController?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

InterstitialEventInteractionDelegate +

+
+
+
    +
  • +
    + + + + willPresentAd() + +
    +
    +
    +
    +
    +
    +

    Called when an ad is about to be presented.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func willPresentAd()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + didDismissAd() + +
    +
    +
    +
    +
    +
    +

    Called when an ad has been dismissed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func didDismissAd()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + willLeaveApp() + +
    +
    +
    +
    +
    +
    +

    Called when the ad causes the app to leave.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func willLeaveApp()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + didClickAd() + +
    +
    +
    +
    +
    +
    +

    Called when an ad is clicked.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func didClickAd()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

BaseInterstitialAdUnitProtocol +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Requests an ad using the provided bid response.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_requestAd(with bidResponse: BidResponse?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Displays the ad using the provided view controller.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_show(from controller: UIViewController?)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Abstract Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Checks if the ad unit is ready to show an ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_isReady() -> Bool
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Notifies the delegate that an ad has been successfully received.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callDelegate_didReceiveAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Notifies the delegate that the ad failed to load.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callDelegate_didFailToReceiveAd(with: Error?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Notifies the delegate that an ad is about to be presented.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callDelegate_willPresentAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Notifies the delegate that an ad has been dismissed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callDelegate_didDismissAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Notifies the delegate that the app is about to leave due to an ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callDelegate_willLeaveApplication()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Notifies the delegate that an ad has been clicked.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callDelegate_didClickAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the loading delegate for the event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_setLoadingDelegate(_ loadingDelegate: NSObject?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the interaction delegate for the event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_setInteractionDelegate()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Shows the ad from the provided view controller.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_showFromViewController(controller: UIViewController?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tracks an impression for the ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func callEventHandler_trackImpression()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/BidInfo.html b/docs/Classes/BidInfo.html new file mode 100644 index 000000000..f174ca333 --- /dev/null +++ b/docs/Classes/BidInfo.html @@ -0,0 +1,631 @@ + + + + BidInfo Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BidInfo

+
+
+ + 
@objcMembers
+@objc(PBMBidInfo)
+public class BidInfo : NSObject
+ +
+
+

Contains information about bid.

+ +
+
+
+
    +
  • +
    + + + + EVENT_WIN + +
    +
    +
    +
    +
    +
    +

    Key to get Prebid win event from events

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let EVENT_WIN: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + EVENT_IMP + +
    +
    +
    +
    +
    +
    +

    Key to get Prebid imp event from events

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let EVENT_IMP: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + resultCode + +
    +
    +
    +
    +
    +
    +

    The result code of the bid request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var resultCode: ResultCode { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + targetingKeywords + +
    +
    +
    +
    +
    +
    +

    Targeting keywords associated with the bid

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var targetingKeywords: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + exp + +
    +
    +
    +
    +
    +
    +

    The expiration time of the bid

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var exp: Double? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + nativeAdCacheId + +
    +
    +
    +
    +
    +
    +

    The cache ID for native ads

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var nativeAdCacheId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + events + +
    +
    +
    +
    +
    +
    +

    Events related to the bid

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var events: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new BidInfo instance with the specified parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(resultCode: ResultCode, targetingKeywords: [String : String]? = nil, exp: Double? = nil,
+            nativeAdCacheId: String? = nil, events: [String: String] = [:])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + resultCode + + +
    +

    The result code of the bid request.

    +
    +
    + + targetingKeywords + + +
    +

    Optional targeting keywords associated with the bid.

    +
    +
    + + exp + + +
    +

    Optional expiration time of the bid.

    +
    +
    + + nativeAdCacheId + + +
    +

    Optional cache ID for native ads.

    +
    +
    + + events + + +
    +

    Optional dictionary of events related to the bid.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getExp() + +
    +
    +
    +
    +
    +
    +

    Retrieves the expiration time of the bid as an NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getExp() -> NSNumber?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/ContextSubType.html b/docs/Classes/ContextSubType.html new file mode 100644 index 000000000..e5cdeb2cf --- /dev/null +++ b/docs/Classes/ContextSubType.html @@ -0,0 +1,670 @@ + + + + ContextSubType Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ContextSubType

+
+
+ + 
@objcMembers
+public class ContextSubType : SingleContainerInt
+ +
+
+

Native context subtype asset.

+ +
+
+
+
    +
  • +
    + + + + General + +
    +
    +
    +
    +
    +
    +

    Represents a general context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let General: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Article + +
    +
    +
    +
    +
    +
    +

    Represents an article context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Article: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Video + +
    +
    +
    +
    +
    +
    +

    Represents a video context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Video: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Audio + +
    +
    +
    +
    +
    +
    +

    Represents an audio context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Audio: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Image + +
    +
    +
    +
    +
    +
    +

    Represents an image context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Image: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + UserGenerated + +
    +
    +
    +
    +
    +
    +

    Represents a user-generated content context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let UserGenerated: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Social + +
    +
    +
    +
    +
    +
    +

    Represents a social media context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Social: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Represents an email context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let email: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + chatIM + +
    +
    +
    +
    +
    +
    +

    Represents a chat or instant messaging context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let chatIM: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SellingProduct + +
    +
    +
    +
    +
    +
    +

    Represents a product selling context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let SellingProduct: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + AppStore + +
    +
    +
    +
    +
    +
    +

    Represents an App Store context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let AppStore: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ReviewSite + +
    +
    +
    +
    +
    +
    +

    Represents a review site context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let ReviewSite: ContextSubType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Custom + +
    +
    +
    +
    +
    +
    +

    Represents a custom context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Custom: ContextSubType
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/ContextType.html b/docs/Classes/ContextType.html new file mode 100644 index 000000000..fafafb270 --- /dev/null +++ b/docs/Classes/ContextType.html @@ -0,0 +1,427 @@ + + + + ContextType Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ContextType

+
+
+ + 
@objcMembers
+public class ContextType : SingleContainerInt
+ +
+
+

Native context type asset.

+ +
+
+
+
    +
  • +
    + + + + Content + +
    +
    +
    +
    +
    +
    +

    Represents a content context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Content: ContextType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Social + +
    +
    +
    +
    +
    +
    +

    Represents a social media context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Social: ContextType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Product + +
    +
    +
    +
    +
    +
    +

    Represents a product context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Product: ContextType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Custom + +
    +
    +
    +
    +
    +
    +

    Represents a custom context type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let Custom: ContextType
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/EventTracking.html b/docs/Classes/EventTracking.html new file mode 100644 index 000000000..b3f95d6b5 --- /dev/null +++ b/docs/Classes/EventTracking.html @@ -0,0 +1,402 @@ + + + + EventTracking Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

EventTracking

+
+
+ + 
public class EventTracking : SingleContainerInt
+ +
+
+

Native event tracking type.

+ +
+
+
+
    +
  • +
    + + + + Image + +
    +
    +
    +
    +
    +
    +

    Represents image-based event tracking.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Image: EventTracking
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + js + +
    +
    +
    +
    +
    +
    +

    Represents JavaScript-based event tracking.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let js: EventTracking
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Custom + +
    +
    +
    +
    +
    +
    +

    Represents a custom event tracking method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Custom: EventTracking
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/EventType.html b/docs/Classes/EventType.html new file mode 100644 index 000000000..8bb1e7635 --- /dev/null +++ b/docs/Classes/EventType.html @@ -0,0 +1,458 @@ + + + + EventType Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

EventType

+
+
+ + 
public class EventType : SingleContainerInt
+ +
+
+

Class representing different event types.

+ +
+
+
+
    +
  • +
    + + + + Impression + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Impression: EventType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ViewableImpression50 + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let ViewableImpression50: EventType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ViewableImpression100 + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let ViewableImpression100: EventType
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let ViewableVideoImpression50: EventType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Custom + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Custom: EventType
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/ExternalUserId.html b/docs/Classes/ExternalUserId.html new file mode 100644 index 000000000..0d7256cec --- /dev/null +++ b/docs/Classes/ExternalUserId.html @@ -0,0 +1,643 @@ + + + + ExternalUserId Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ExternalUserId

+
+
+ + 
@objcMembers
+public class ExternalUserId : NSObject, NSCoding, NSSecureCoding, JSONConvertible
+ +
+
+

Defines the User Id Object from an External Thrid Party Source

+ +
+
+
+
    +
  • +
    + + + + supportsSecureCoding + +
    +
    +
    +
    +
    +
    +

    Indicates whether the class supports secure coding.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static var supportsSecureCoding: Bool { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + source + +
    +
    +
    +
    +
    +
    +

    The source of the external user ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var source: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + identifier + +
    +
    +
    +
    +
    +
    +

    The identifier of the external user ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var identifier: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + atype + +
    +
    +
    +
    +
    +
    +

    The type of the external user ID, represented as an optional NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var atype: NSNumber?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ext + +
    +
    +
    +
    +
    +
    +

    Additional attributes related to the external user ID, represented as an optional dictionary.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var ext: [String : Any]?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initialization +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initialize ExternalUserId Class

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(source: String, identifier: String, atype: NSNumber? = nil, ext: [String : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + source + + +
    +

    Source of the External User Id String.

    +
    +
    + + identifier + + +
    +

    String of the External User Id.

    +
    +
    + + atype + + +
    +

    (Optional) Int of the External User Id.

    +
    +
    + + ext + + +
    +

    (Optional) Dictionary of the External User Id.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + encode(with:) + +
    +
    +
    +
    +
    +
    +

    Encodes the properties of the class using the given encoder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(with coder: NSCoder)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(coder:) + +
    +
    +
    +
    +
    +
    +

    Initializes an ExternalUserId instance from the given decoder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init?(coder: NSCoder)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + toJSONDictionary() + +
    +
    +
    +
    +
    +
    +

    Converts the ExternalUserId instance to a JSON dictionary.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toJSONDictionary() -> [AnyHashable : Any]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/Host.html b/docs/Classes/Host.html new file mode 100644 index 000000000..3b212e077 --- /dev/null +++ b/docs/Classes/Host.html @@ -0,0 +1,428 @@ + + + + Host Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Host

+
+
+ + 
@objcMembers
+public class Host : NSObject
+ +
+
+

A singleton class that manages the Prebid server URL, including a custom URL.

+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    The class is created as a singleton object & used

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let shared: Host
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setCustomHostURL(_:) + +
    +
    +
    +
    +
    +
    +

    The CustomHost property holds the URL for the custom prebid adaptor

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func setCustomHostURL(_ urlString: String?) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + getHostURL(host:) + +
    +
    +
    +
    +
    +
    +

    This function retrieves the prebid server URL for the selected host

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getHostURL(host: PrebidHost) throws -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verifyUrl(urlString:) + +
    +
    +
    +
    +
    +
    +

    This function verifies if the prebid server URL is in the url format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func verifyUrl(urlString: String?) -> Bool
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/ImageAsset.html b/docs/Classes/ImageAsset.html new file mode 100644 index 000000000..41c974407 --- /dev/null +++ b/docs/Classes/ImageAsset.html @@ -0,0 +1,402 @@ + + + + ImageAsset Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ImageAsset

+
+
+ + 
public class ImageAsset : SingleContainerInt
+ +
+
+

Native image asset type.

+ +
+
+
+
    +
  • +
    + + + + Icon + +
    +
    +
    +
    +
    +
    +

    Represents an icon image asset.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Icon: ImageAsset
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Main + +
    +
    +
    +
    +
    +
    +

    Represents the main image asset.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Main: ImageAsset
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Custom + +
    +
    +
    +
    +
    +
    +

    Represents a custom image asset.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public static let Custom: ImageAsset
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/InstreamVideoAdUnit.html b/docs/Classes/InstreamVideoAdUnit.html new file mode 100644 index 000000000..32a441470 --- /dev/null +++ b/docs/Classes/InstreamVideoAdUnit.html @@ -0,0 +1,403 @@ + + + + InstreamVideoAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

InstreamVideoAdUnit

+
+
+ + 
public class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
+ +
+
+

Represents an instream video ad unit for original type of integration.

+ +
+
+
+
    +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    The video parameters for this ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var videoParameters: VideoParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(configId:size:) + +
    +
    +
    +
    +
    +
    +

    Initializes a new instream video ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configId: String, size: CGSize)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configId + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + size + + +
    +

    The size of the ad.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/InterstitialAdUnit.html b/docs/Classes/InterstitialAdUnit.html new file mode 100644 index 000000000..05a725603 --- /dev/null +++ b/docs/Classes/InterstitialAdUnit.html @@ -0,0 +1,543 @@ + + + + InterstitialAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

InterstitialAdUnit

+
+
+ + 
public class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
+ +
+
+

Represents an interstitial ad unit built for original type of integration.

+ +
+
+
+
    +
  • +
    + + + + parameters + +
    +
    +
    +
    +
    +
    +

    The deprecated banner parameters for this ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This property is deprecated. Please, use bannerParameters instead.")
+public var parameters: BannerParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bannerParameters + +
    +
    +
    +
    +
    +
    +

    The banner parameters for this ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bannerParameters: BannerParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    The video parameters for this ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var videoParameters: VideoParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adFormats + +
    +
    +
    +
    +
    +
    +

    The ad formats for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var adFormats: Set<AdFormat> { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(configId:) + +
    +
    +
    +
    +
    +
    +

    Initializes a new interstitial ad unit with a unique configuration identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configId: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + configId + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new interstitial ad unit with a minimum width and height percentage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(configId: String, minWidthPerc: Int, minHeightPerc: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configId + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minWidthPerc + + +
    +

    The minimum width percentage of the ad.

    +
    +
    + + minHeightPerc + + +
    +

    The minimum height percentage of the ad.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/InterstitialRenderingAdUnit.html b/docs/Classes/InterstitialRenderingAdUnit.html new file mode 100644 index 000000000..25fb60413 --- /dev/null +++ b/docs/Classes/InterstitialRenderingAdUnit.html @@ -0,0 +1,917 @@ + + + + InterstitialRenderingAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

InterstitialRenderingAdUnit

+
+
+ + 
@objcMembers
+public class InterstitialRenderingAdUnit : BaseInterstitialAdUnit
+ +
+
+

Represents an interstitial ad unit. Built for rendering type of integration.

+ +
+
+
+
    +
  • +
    + + + + skipButtonArea + +
    +
    +
    +
    +
    +
    +

    The area of the skip button in the video controls, specified as a percentage of the screen width.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var skipButtonArea: Double { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + skipButtonPosition + +
    +
    +
    +
    +
    +
    +

    The position of the skip button in the video controls.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var skipButtonPosition: Position { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + skipDelay + +
    +
    +
    +
    +
    +
    +

    The delay before the skip button appears, in seconds.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public var skipDelay: Double { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(configID:) + +
    +
    +
    +
    +
    +
    +

    Initializes a new interstitial rendering ad unit with the specified configuration ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public init(configID: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new interstitial rendering ad unit with the specified configuration ID and minimum size percentage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public init(configID: String, minSizePercentage: CGSize)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minSizePercentage + + +
    +

    The minimum size percentage of the ad.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new interstitial rendering ad unit with the specified configuration ID, minimum size percentage, and event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public init(configID: String, minSizePercentage: CGSize, eventHandler: AnyObject)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minSizePercentage + + +
    +

    The minimum size percentage of the ad.

    +
    +
    + + eventHandler + + +
    +

    The event handler to manage ad events.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Protected overrides +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Called when an ad is successfully received.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callDelegate_didReceiveAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad fails to be received.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callDelegate_didFailToReceiveAd(with error: Error?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad will be presented.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callDelegate_willPresentAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad is dismissed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callDelegate_didDismissAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the user will leave the application.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callDelegate_willLeaveApplication()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Called when the ad is clicked.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callDelegate_didClickAd()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Checks if the ad is ready to be displayed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callEventHandler_isReady() -> Bool
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the loading delegate for the event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callEventHandler_setLoadingDelegate(_ loadingDelegate: NSObject?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the interaction delegate for the event handler.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callEventHandler_setInteractionDelegate()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Requests an ad with the specified bid response

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callEventHandler_requestAd(with bidResponse: BidResponse?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Shows the ad from the specified view controller.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callEventHandler_show(from controller: UIViewController?)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tracks an impression for the ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func callEventHandler_trackImpression()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/MediationBannerAdUnit.html b/docs/Classes/MediationBannerAdUnit.html new file mode 100644 index 000000000..e1cfa73e1 --- /dev/null +++ b/docs/Classes/MediationBannerAdUnit.html @@ -0,0 +1,1633 @@ + + + + MediationBannerAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediationBannerAdUnit

+
+
+ + 
@objcMembers
+public class MediationBannerAdUnit : NSObject
+ +
+
+

This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

+ +
+
+
+
    +
  • +
    + + + + mediationDelegate + +
    +
    +
    +
    +
    +
    +

    Property that performs certain utilty work for the MediationBannerAdUnit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let mediationDelegate: PrebidMediationDelegate
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Computed properties +

+
+
+
    +
  • +
    + + + + configID + +
    +
    +
    +
    +
    +
    +

    The configuration ID for an ad unit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var configID: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adFormat + +
    +
    +
    +
    +
    +
    +

    The ad format for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var adFormat: AdFormat { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adPosition + +
    +
    +
    +
    +
    +
    +

    The position of the ad on the screen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var adPosition: AdPosition { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bannerParameters + +
    +
    +
    +
    +
    +
    +

    Parameters for configuring banner ads.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bannerParameters: BannerParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    Parameters for configuring video ads.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var videoParameters: VideoParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + refreshInterval + +
    +
    +
    +
    +
    +
    +

    The refresh interval for the ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var refreshInterval: TimeInterval { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + additionalSizes + +
    +
    +
    +
    +
    +
    +

    Additional sizes for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var additionalSizes: [CGSize]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ortbConfig + +
    +
    +
    +
    +
    +
    +

    OpenRTB configuration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var ortbConfig: String? { get set }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext Data (imp[].ext.data) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & value for adunit context targeting +if the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & values for adunit context targeting +the values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context data keyword & values set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearContextData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all context data set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & values for adunit targeting. +The values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateExtData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific ext data keyword & values set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all ext data set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext keywords (imp[].ext.keywords) +

+
+
+
    +
  • +
    + + + + addContextKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context keyword from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeywords(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + removeExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method allows to remove specific keyword from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtKeywords() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtKeywords()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

App Content (app.content.data) +

+
+
+
    +
  • +
    + + + + setAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the app content object, replacing any existing content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setAppContent(_ appContentObject: PBMORTBAppContent)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + appContentObject + + +
    +

    The PBMORTBAppContent object representing the app’s content.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getAppContent() + +
    +
    +
    +
    +
    +
    +

    Retrieves the current app content object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getAppContent() -> PBMORTBAppContent?
    + +
    +
    +
    +

    Return Value

    +

    The current PBMORTBAppContent object, or nil if no content is set.

    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContent() + +
    +
    +
    +
    +
    +
    +

    Clears the current app content object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContent()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addAppContentData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of content data objects to the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addAppContentData(_ dataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObjects + + +
    +

    An array of PBMORTBContentData objects to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes a specific content data object from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeAppContentData(_ dataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObject + + +
    +

    The PBMORTBContentData object to remove.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContentData() + +
    +
    +
    +
    +
    +
    +

    Clears all content data objects from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContentData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

User Data (user.data) +

+
+
+
    +
  • +
    + + + + addUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addUserData(_ userDataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObjects + + +
    +

    An array of PBMORTBContentData objects to add to the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a specific user data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeUserData(_ userDataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObject + + +
    +

    The PBMORTBContentData object to remove from the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearUserData() + +
    +
    +
    +
    +
    +
    +

    Clears all user data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearUserData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a new mediation banner ad unit with the specified configuration ID, size, and mediation delegate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configID: String, size: CGSize, mediationDelegate: PrebidMediationDelegate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configID + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + size + + +
    +

    The size of the ad.

    +
    +
    + + mediationDelegate + + +
    +

    The delegate for handling mediation.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Makes bid request and setups mediation parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchDemand(completion: ((ResultCode) -> Void)?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion handler to call when the demand fetch is complete.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + stopRefresh() + +
    +
    +
    +
    +
    +
    +

    Stops the auto-refresh for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func stopRefresh()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Handles the event when the ad object fails to load an ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func adObjectDidFailToLoadAd(adObject: UIView,
+                                    with error: Error)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + adObject + + +
    +

    The ad object that failed to load the ad.

    +
    +
    + + error + + +
    +

    The error that occurred during the ad load.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/MediationBaseInterstitialAdUnit.html b/docs/Classes/MediationBaseInterstitialAdUnit.html new file mode 100644 index 000000000..dd22c2b74 --- /dev/null +++ b/docs/Classes/MediationBaseInterstitialAdUnit.html @@ -0,0 +1,1392 @@ + + + + MediationBaseInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediationBaseInterstitialAdUnit

+
+
+ + 
@objcMembers
+public class MediationBaseInterstitialAdUnit : NSObject
+ +
+
+

Base class for interstitial ads in Mediation API.

+ +
+
+
+
    +
  • +
    + + + + bannerParameters + +
    +
    +
    +
    +
    +
    +

    Parameters for configuring banner ads.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bannerParameters: BannerParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + videoParameters + +
    +
    +
    +
    +
    +
    +

    Parameters for configuring video ads.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var videoParameters: VideoParameters { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isMuted + +
    +
    +
    +
    +
    +
    +

    Indicates whether the video ad is muted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isMuted: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isSoundButtonVisible + +
    +
    +
    +
    +
    +
    +

    Indicates whether the sound button is visible in the video ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isSoundButtonVisible: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + closeButtonArea + +
    +
    +
    +
    +
    +
    +

    The area for the close button in the video ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var closeButtonArea: Double { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + closeButtonPosition + +
    +
    +
    +
    +
    +
    +

    The position of the close button in the video ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var closeButtonPosition: Position { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ortbConfig + +
    +
    +
    +
    +
    +
    +

    OpenRTB configuration for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var ortbConfig: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + configId + +
    +
    +
    +
    +
    +
    +

    The configuration ID for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var configId: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Makes bid request and setups mediation parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchDemand(completion: ((ResultCode) -> Void)?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A closure called with the result code indicating the outcome of the demand fetch.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext Data (imp[].ext.data) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & value for adunit context targeting +if the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & values for adunit context targeting +the values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context data keyword & values set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearContextData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all context data set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & values for adunit targeting. +The values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateExtData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific ext data keyword & values set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all ext data set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext keywords (imp[].ext.keywords) +

+
+
+
    +
  • +
    + + + + addContextKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context keyword from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeywords(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + removeExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method allows to remove specific keyword from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtKeywords() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtKeywords()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

App Content (app.content.data) +

+
+
+
    +
  • +
    + + + + setAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the app content object, replacing any existing content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setAppContent(_ appContentObject: PBMORTBAppContent)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + appContentObject + + +
    +

    The PBMORTBAppContent object representing the app’s content.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContent() + +
    +
    +
    +
    +
    +
    +

    Clears the current app content object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContent()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addAppContentData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of content data objects to the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addAppContentData(_ dataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObjects + + +
    +

    An array of PBMORTBContentData objects to add.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Removes a specific content data object from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeAppContentData(_ dataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObject + + +
    +

    The PBMORTBContentData object to remove.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContentData() + +
    +
    +
    +
    +
    +
    +

    Clears all content data objects from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContentData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

User Data (user.data) +

+
+
+
    +
  • +
    + + + + addUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addUserData(_ userDataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObjects + + +
    +

    An array of PBMORTBContentData objects to add to the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a specific user data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeUserData(_ userDataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObject + + +
    +

    The PBMORTBContentData object to remove from the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearUserData() + +
    +
    +
    +
    +
    +
    +

    Clears all user data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearUserData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/MediationInterstitialAdUnit.html b/docs/Classes/MediationInterstitialAdUnit.html new file mode 100644 index 000000000..779226cb9 --- /dev/null +++ b/docs/Classes/MediationInterstitialAdUnit.html @@ -0,0 +1,645 @@ + + + + MediationInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediationInterstitialAdUnit

+
+
+ + 
@objcMembers
+public class MediationInterstitialAdUnit : MediationBaseInterstitialAdUnit
+ +
+
+

This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + adFormats + +
    +
    +
    +
    +
    +
    +

    The ad format for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var adFormats: Set<AdFormat> { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + additionalSizes + +
    +
    +
    +
    +
    +
    +

    Additional sizes for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var additionalSizes: [CGSize]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + skipButtonArea + +
    +
    +
    +
    +
    +
    +

    The area for the skip button in the video ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var skipButtonArea: Double { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + skipButtonPosition + +
    +
    +
    +
    +
    +
    +

    The position of the skip button in the video ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var skipButtonPosition: Position { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + skipDelay + +
    +
    +
    +
    +
    +
    +

    The delay before the skip button appears in the video ad.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var skipDelay: Double { get set }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Convenience initializer for the mediation interstitial ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override convenience init(configId: String, mediationDelegate: PrebidMediationDelegate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configId + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + mediationDelegate + + +
    +

    The delegate for handling mediation.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a new mediation interstitial ad unit with the specified configuration ID, minimum size percentage, and mediation delegate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configId: String, minSizePercentage: CGSize?, mediationDelegate: PrebidMediationDelegate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configId + + +
    +

    The unique identifier for the ad unit configuration.

    +
    +
    + + minSizePercentage + + +
    +

    The minimum size percentage for the ad.

    +
    +
    + + mediationDelegate + + +
    +

    The delegate for handling mediation.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Computed Properties +

+
+
+
    +
  • +
    + + + + configId + +
    +
    +
    +
    +
    +
    +

    The configuration ID for the ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override var configId: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/MediationNativeAdUnit.html b/docs/Classes/MediationNativeAdUnit.html new file mode 100644 index 000000000..477bea6b2 --- /dev/null +++ b/docs/Classes/MediationNativeAdUnit.html @@ -0,0 +1,1840 @@ + + + + MediationNativeAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediationNativeAdUnit

+
+
+ + 
@objcMembers
+public class MediationNativeAdUnit : NSObject
+ +
+
+

This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + nativeAdUnit + +
    +
    +
    +
    +
    +
    +

    The native ad unit that makes native request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var nativeAdUnit: NativeRequest
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a new instance of the MediationNativeAdUnit with the specified configuration ID and mediation delegate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(configId: String, mediationDelegate: PrebidMediationDelegate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configId + + +
    +

    The configuration ID for the ad unit.

    +
    +
    + + mediationDelegate + + +
    +

    The delegate for mediation-related tasks.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addEventTracker(_:) + +
    +
    +
    +
    +
    +
    +

    Adds event trackers to the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addEventTracker(_ eventTrackers: [NativeEventTracker])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + eventTrackers + + +
    +

    An array of NativeEventTracker objects to add.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addNativeAssets(_:) + +
    +
    +
    +
    +
    +
    +

    Adds native assets to the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addNativeAssets(_ assets: [NativeAsset])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + assets + + +
    +

    An array of NativeAsset objects to add.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setContextType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the context type for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setContextType(_ contextType: ContextType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + contextType + + +
    +

    The context type to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setPlacementType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the placement type for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setPlacementType(_ placementType: PlacementType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + placementType + + +
    +

    The placement type to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setPlacementCount(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the placement count for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setPlacementCount(_ placementCount: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + placementCount + + +
    +

    The placement count to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setContextSubType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the context subtype for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setContextSubType(_ contextSubType: ContextSubType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + contextSubType + + +
    +

    The context subtype to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setSequence(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the sequence for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setSequence(_ sequence: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + sequence + + +
    +

    The sequence to set.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the asset URL support for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setAssetURLSupport(_ assetURLSupport: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + assetURLSupport + + +
    +

    The asset URL support value to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setDURLSupport(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the DURL support for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setDURLSupport(_ dURLSupport: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dURLSupport + + +
    +

    The DURL support value to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setPrivacy(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the privacy value for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setPrivacy(_ privacy: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + privacy + + +
    +

    The privacy value to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setExt(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the extended data for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setExt(_ ext: [String : Any])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + ext + + +
    +

    A dictionary containing the extended data to set.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getOrtbConfig() + +
    +
    +
    +
    +
    +
    +

    Retrieves the OpenRTB configuration for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getOrtbConfig() -> String?
    + +
    +
    +
    +

    Return Value

    +

    The OpenRTB configuration as a string, or nil if not set.

    +
    +
    +
    +
    • +
  • +
    + + + + setOrtbConfig(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the OpenRTB configuration for the native ad unit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setOrtbConfig(_ ortbConfig: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + ortbConfig + + +
    +

    The OpenRTB configuration to set.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

App Content (app.content.data) +

+
+
+
    +
  • +
    + + + + setAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the app content object, replacing any existing content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setAppContent(_ appContent: PBMORTBAppContent)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + appContent + + +
    +

    The PBMORTBAppContent object representing the app’s content.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearAppContent() + +
    +
    +
    +
    +
    +
    +

    Clears the current app content object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearAppContent()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addAppContentData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of content data objects to the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addAppContentData(_ dataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObjects + + +
    +

    An array of PBMORTBContentData objects to add.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeAppContent(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a specific content data object from the app content.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeAppContent(_ dataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dataObject + + +
    +

    The PBMORTBContentData object to remove.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

User Data (user.data) +

+
+
+
    +
  • +
    + + + + addUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Adds an array of user data objects.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addUserData(_ userDataObjects: [PBMORTBContentData])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObjects + + +
    +

    An array of PBMORTBContentData objects to add to the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + removeUserData(_:) + +
    +
    +
    +
    +
    +
    +

    Removes a specific user data object.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeUserData(_ userDataObject: PBMORTBContentData)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userDataObject + + +
    +

    The PBMORTBContentData object to remove from the user data.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + clearUserData() + +
    +
    +
    +
    +
    +
    +

    Clears all user data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearUserData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext Data (imp[].ext.data) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & value for adunit context targeting +if the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context data keyword & values for adunit context targeting +the values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context data keyword & values set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearContextData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all context data set from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtData(key: String, value: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the ext data keyword & values for adunit targeting. +The values if the key already exist will be replaced with the new set of values

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateExtData(key: String, value: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific ext data keyword & values set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtData(forKey: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtData() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all ext data set from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtData()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Ext keywords (imp[].ext.keywords) +

+
+
+
    +
  • +
    + + + + addContextKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove specific context keyword from adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit context targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeyword(_ newElement: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addExtKeywords(_:) + +
    +
    +
    +
    +
    +
    +

    This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func addExtKeywords(_ newElements: Set<String>)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + removeExtKeyword(_:) + +
    +
    +
    +
    +
    +
    +

    This method allows to remove specific keyword from adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func removeExtKeyword(_ element: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearExtKeywords() + +
    +
    +
    +
    +
    +
    +

    This method allows to remove all keywords from the set of adunit targeting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func clearExtKeywords()
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Makes bid request for the native ad unit and setups mediation parameters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchDemand(completion: ((ResultCode) -> Void)?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion handler to call with the result code.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/MediationRewardedAdUnit.html b/docs/Classes/MediationRewardedAdUnit.html new file mode 100644 index 000000000..2af8aade6 --- /dev/null +++ b/docs/Classes/MediationRewardedAdUnit.html @@ -0,0 +1,387 @@ + + + + MediationRewardedAdUnit Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediationRewardedAdUnit

+
+
+ + 
@objcMembers
+public class MediationRewardedAdUnit : MediationBaseInterstitialAdUnit
+ +
+
+

This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

+ +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a new instance of the MediationRewardedAdUnit with the specified configuration ID and mediation delegate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init(configId: String, mediationDelegate: PrebidMediationDelegate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + configId + + +
    +

    The configuration ID for the ad unit.

    +
    +
    + + mediationDelegate + + +
    +

    The delegate for mediation-related tasks.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/NativeAd.html b/docs/Classes/NativeAd.html new file mode 100644 index 000000000..28eb0d3fb --- /dev/null +++ b/docs/Classes/NativeAd.html @@ -0,0 +1,870 @@ + + + + NativeAd Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

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.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/NativeAdConfiguration.html b/docs/Classes/NativeAdConfiguration.html new file mode 100644 index 000000000..c56c861f4 --- /dev/null +++ b/docs/Classes/NativeAdConfiguration.html @@ -0,0 +1,401 @@ + + + + NativeAdConfiguration Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NativeAdConfiguration

+
+
+ + 
@objc(PBMNativeAdConfiguration)
+@objcMembers
+public class NativeAdConfiguration : NSObject
+ +
+
+

Represents the configuration for a native ad, including markup and version information.

+ +
+
+
+
    +
  • +
    + + + + version + +
    +
    +
    +
    +
    +
    +

    Version of the Native Markup version in use.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var version: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + markupRequestObject + +
    +
    +
    +
    +
    +
    +

    The object containing the request details for the native markup.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var markupRequestObject: NativeMarkupRequestObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Initializes a new instance of NativeAdMarkup with default values.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + diff --git a/docs/Classes/NativeAdMarkup.html b/docs/Classes/NativeAdMarkup.html new file mode 100644 index 000000000..b7c028eaf --- /dev/null +++ b/docs/Classes/NativeAdMarkup.html @@ -0,0 +1,726 @@ + + + + NativeAdMarkup Class Reference + + + + + + + + + + + + + +
+
+

PrebidMobile 2.2.3 Docs (94% documented)

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NativeAdMarkup

+
+
+ + 
@objcMembers
+public class NativeAdMarkup : NSObject, JsonDecodable
+ +
+
+

Represents the markup for a native ad, including assets, tracking URLs, and other metadata.

+ +
+
+
+
    +
  • +
    + + + + version + +
    +
    +
    +
    +
    +
    +

    Version of the Native Markup version in use.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var version: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + assets + +
    +
    +
    +
    +
    +
    +

    List of native ad’s assets. +Required if no assetsurl. +Recommended as fallback even if assetsurl is provided.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var assets: [NativeAdMarkupAsset]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + assetsurl + +
    +
    +
    +
    +
    +
    +

    URL of an alternate source for the assets object. +The expected response is a JSON object mirroring the assets object in the bid response, +subject to certain requirements as specified in the individual objects. +Where present, overrides the asset object in the response.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var assetsurl: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dcourl + +
    +
    +
    +
    +
    +
    +

    URL where a dynamic creative specification may be found for populating this ad, per the Dynamic Content Ads Specification. +Note this is a beta option as the interpretation of the Dynamic Content Ads Specification and how to assign those elements +into a native ad is outside the scope of this spec and must be agreed offline between the parties +or as may be specified in a future revision of the Dynamic Content Ads spec. +Where present, overrides the asset object in the response.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dcourl: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + link + +
    +
    +
    +
    +
    +
    +

    Destination Link. +This is default link object for the ad. +Individual assets can also have a link object which applies if the asset is activated(clicked). +If the asset doesn’t have a link object, the parent link object applies. +See LinkObject Definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var link: NativeLink?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + imptrackers + +
    +
    +
    +
    +
    +
    +

    Array of impression tracking URLs, expected to return a 1x1 image or 204 response - typically only passed when using 3rd party trackers. +To be deprecated - replaced with eventtrackers.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var imptrackers: [String]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + jstracker + +
    +
    +
    +
    +
    +
    +

    Optional JavaScript impression tracker. +This is a valid HTML, Javascript is already wrapped in + + + + + + + + + +

    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAdMarkupAsset

    +
    +
    + + 
    @objcMembers
+public class NativeAdMarkupAsset : NSObject, JsonDecodable
    + +
    +
    +

    Represents an asset in the native ad markup, which can be a title, image, data, or link.

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Optional if asseturl/dcourl is being used; required if embeded asset is being used

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var id: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + required + +
      +
      +
      +
      +
      +
      +

      Set to 1 if asset is required. (bidder requires it to be displayed).

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var required: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + title + +
      +
      +
      +
      +
      +
      +

      Title object for title assets. +See TitleObject definition.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var title: NativeTitle?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + img + +
      +
      +
      +
      +
      +
      +

      Image object for image assets. +See ImageObject definition.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var img: NativeImage?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + data + +
      +
      +
      +
      +
      +
      +

      Data object for ratings, prices etc.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var data: NativeData?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + link + +
      +
      +
      +
      +
      +
      +

      Link object for call to actions. +The link object applies if the asset item is activated (clicked). +If there is no link object on the asset, the parent link object on the bid response applies.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var link: NativeLink?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(jsonDictionary:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAdMarkupAsset from a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(jsonDictionary: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + jsonDictionary + + +
      +

      A dictionary representing the asset in the native ad markup.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAdMarkupAsset with default values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeAsset.html b/docs/Classes/NativeAsset.html new file mode 100644 index 000000000..a1dc2e5c1 --- /dev/null +++ b/docs/Classes/NativeAsset.html @@ -0,0 +1,391 @@ + + + + NativeAsset Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAsset

    +
    +
    + + 
    public class NativeAsset : NSObject
    + +
    +
    +

    Represents a generic native ad asset which could be a title, image, or data.

    + +
    +
    +
    +
      +
    • +
      + + + + required + +
      +
      +
      +
      +
      +
      +

      Indicates whether the asset is required for the ad to be considered valid.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var required: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(isRequired:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAsset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(isRequired: Bool)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + isRequired + + +
      +

      A boolean indicating whether the asset is required.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeAssetData.html b/docs/Classes/NativeAssetData.html new file mode 100644 index 000000000..3d50f8dc2 --- /dev/null +++ b/docs/Classes/NativeAssetData.html @@ -0,0 +1,431 @@ + + + + NativeAssetData Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAssetData

    +
    +
    + + 
    @objcMembers
+public class NativeAssetData : NativeAsset
    + +
    +
    +

    Represents a data asset in a native ad.

    + +
    +
    +
    +
      +
    • +
      + + + + length + +
      +
      +
      +
      +
      +
      +

      The length of the data asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var length: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      Additional custom properties for the data asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: AnyObject?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(type:required:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAssetData.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(type: DataAsset, required: Bool)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + type + + +
      +

      The type of the data asset.

      +
      +
      + + required + + +
      +

      A boolean indicating whether the asset is required.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeAssetImage.html b/docs/Classes/NativeAssetImage.html new file mode 100644 index 000000000..2b9477a22 --- /dev/null +++ b/docs/Classes/NativeAssetImage.html @@ -0,0 +1,624 @@ + + + + NativeAssetImage Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAssetImage

    +
    +
    + + 
    @objcMembers
+public class NativeAssetImage : NativeAsset
    + +
    +
    +

    Represents an image asset in a native ad.

    + +
    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      The type of the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var type: ImageAsset?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + width + +
      +
      +
      +
      +
      +
      +

      The width of the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var width: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + widthMin + +
      +
      +
      +
      +
      +
      +

      The minimum width of the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var widthMin: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + height + +
      +
      +
      +
      +
      +
      +

      The height of the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var height: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + heightMin + +
      +
      +
      +
      +
      +
      +

      The minimum height of the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var heightMin: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + mimes + +
      +
      +
      +
      +
      +
      +

      The MIME types supported for the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var mimes: Array<String>?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      Additional custom properties for the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: AnyObject?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAssetImage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(minimumWidth: Int, minimumHeight: Int, required: Bool)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + minimumWidth + + +
      +

      The minimum width of the image.

      +
      +
      + + minimumHeight + + +
      +

      The minimum height of the image.

      +
      +
      + + required + + +
      +

      A boolean indicating whether the asset is required.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init(isRequired:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAssetImage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init(isRequired: Bool)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + isRequired + + +
      +

      A boolean indicating whether the asset is required.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeAssetTitle.html b/docs/Classes/NativeAssetTitle.html new file mode 100644 index 000000000..df3ec37bb --- /dev/null +++ b/docs/Classes/NativeAssetTitle.html @@ -0,0 +1,404 @@ + + + + NativeAssetTitle Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAssetTitle

    +
    +
    + + 
    @objcMembers
+public class NativeAssetTitle : NativeAsset
    + +
    +
    +

    Represents a title asset in a native ad.

    + +
    +
    +
    +
      +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      Additional custom properties for the title asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: AnyObject?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAssetTitle.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(length: NSInteger, required: Bool)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + length + + +
      +

      The maximum length of the title.

      +
      +
      + + required + + +
      +

      A boolean indicating whether the asset is required.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeData.html b/docs/Classes/NativeData.html new file mode 100644 index 000000000..8c2b5155e --- /dev/null +++ b/docs/Classes/NativeData.html @@ -0,0 +1,505 @@ + + + + NativeData Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeData

    +
    +
    + + 
    @objcMembers
+public class NativeData : NSObject, JsonDecodable
    + +
    +
    +

    Class representing native data elements in the ad markup.

    + +
    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      The type of data element being submitted from the Data Asset Types table. +Required for assetsurl/dcourl responses, not required for embedded asset responses.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var type: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + length + +
      +
      +
      +
      +
      +
      +

      The length of the data element being submitted. +Required for assetsurl/dcourl responses, not required for embedded asset responses. +Where applicable, must comply with the recommended maximum lengths in the Data Asset Types table.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var length: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + value + +
      +
      +
      +
      +
      +
      +

      The formatted string of data to be displayed. +Can contain a formatted value such as “5 stars” or “$10” or “3.4 stars out of 5”.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var value: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(jsonDictionary:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new NativeData object with the provided JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(jsonDictionary: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + jsonDictionary + + +
      +

      A dictionary containing the JSON data to initialize the object.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeEventTracker.html b/docs/Classes/NativeEventTracker.html new file mode 100644 index 000000000..dee3b286b --- /dev/null +++ b/docs/Classes/NativeEventTracker.html @@ -0,0 +1,378 @@ + + + + NativeEventTracker Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeEventTracker

    +
    +
    + + 
    @objc
+public class NativeEventTracker : NSObject
    + +
    +
    +

    Class representing an event tracker for native ads.

    + +
    +
    +
    +
      +
    • +
      + + + + init(event:methods:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new NativeEventTracker instance.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public init(event: EventType, methods: Array<EventTracking>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + event + + +
      +

      The event type to track.

      +
      +
      + + methods + + +
      +

      The methods used for tracking the event.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeEventTrackerResponse.html b/docs/Classes/NativeEventTrackerResponse.html new file mode 100644 index 000000000..cf9a34f06 --- /dev/null +++ b/docs/Classes/NativeEventTrackerResponse.html @@ -0,0 +1,531 @@ + + + + NativeEventTrackerResponse Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeEventTrackerResponse

    +
    +
    + + 
    @objcMembers
+public class NativeEventTrackerResponse : NSObject, JsonDecodable
    + +
    +
    +

    Class representing a response for a native event tracker.

    + +
    +
    +
    +
      +
    • +
      + + + + event + +
      +
      +
      +
      +
      +
      +

      Type of event to track. +See Event Types table.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var event: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + method + +
      +
      +
      +
      +
      +
      +

      Type of tracking requested. +See Event Tracking Methods table.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var method: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + url + +
      +
      +
      +
      +
      +
      +

      The URL of the image or js. +Required for image or js, optional for custom.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var url: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + customdata + +
      +
      +
      +
      +
      +
      +

      To be agreed individually with the exchange, an array of key:value objects for custom tracking, +for example the account number of the DSP with a tracking company. IE {“accountnumber”:”123”}.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var customdata: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(jsonDictionary:) + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeEventTrackerResponse object from a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(jsonDictionary: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + jsonDictionary + + +
      +

      A dictionary containing the JSON data to initialize the object.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes with default values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeImage.html b/docs/Classes/NativeImage.html new file mode 100644 index 000000000..afbea0bbf --- /dev/null +++ b/docs/Classes/NativeImage.html @@ -0,0 +1,533 @@ + + + + NativeImage Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeImage

    +
    +
    + + 
    @objcMembers
+public class NativeImage : NSObject, JsonDecodable
    + +
    +
    +

    Class representing an image asset in a native ad.

    + +
    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      The type of image element being submitted from the Image Asset Types table. +Required for assetsurl or dcourl responses, not required for embedded asset responses.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var type: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + url + +
      +
      +
      +
      +
      +
      +

      URL of the image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var url: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + width + +
      +
      +
      +
      +
      +
      +

      Width of the image in pixels. +Recommended for embedded asset responses. +Required for assetsurl/dcourlresponses if multiple assets of same type submitted.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var width: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + height + +
      +
      +
      +
      +
      +
      +

      Height of the image in pixels. +Recommended for embedded asset responses. +Required for assetsurl/dcourl responses if multiple assets of same type submitted.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var height: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(jsonDictionary:) + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeImage object from a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(jsonDictionary: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + jsonDictionary + + +
      +

      A dictionary containing the JSON data to initialize the object.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes with default values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeLink.html b/docs/Classes/NativeLink.html new file mode 100644 index 000000000..a8cd21371 --- /dev/null +++ b/docs/Classes/NativeLink.html @@ -0,0 +1,501 @@ + + + + NativeLink Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeLink

    +
    +
    + + 
    @objcMembers
+public class NativeLink : NSObject, JsonDecodable
    + +
    +
    +

    Class representing a link in a native ad.

    + +
    +
    +
    +
      +
    • +
      + + + + url + +
      +
      +
      +
      +
      +
      +

      Landing URL of the clickable link.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var url: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clicktrackers + +
      +
      +
      +
      +
      +
      +

      List of third-party tracker URLs to be fired on click of the URL.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var clicktrackers: [String]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + fallback + +
      +
      +
      +
      +
      +
      +

      Fallback URL for deeplink. +To be used if the URL given in url is not supported by the device.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var fallback: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(jsonDictionary:) + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeLink object from a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(jsonDictionary: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + jsonDictionary + + +
      +

      A dictionary containing the JSON data to initialize the object.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes with default values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeMarkupRequestObject.html b/docs/Classes/NativeMarkupRequestObject.html new file mode 100644 index 000000000..146b9ba0c --- /dev/null +++ b/docs/Classes/NativeMarkupRequestObject.html @@ -0,0 +1,806 @@ + + + + NativeMarkupRequestObject Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeMarkupRequestObject

    +
    +
    + + 
    @objc(PBMNativeMarkupRequestObject)
+@objcMembers
+public class NativeMarkupRequestObject : NSObject, NSCopying, PBMJsonCodable
    + +
    +
    +

    Represents a request object for native markup, including details about the ad’s context, placement, and supported features.

    + +
    +
    +
    +
      +
    • +
      + + + + context + +
      +
      +
      +
      +
      +
      +

      [Recommended] +[Integer] +The context in which the ad appears. +See NativeContextType

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var context: ContextType?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + contextsubtype + +
      +
      +
      +
      +
      +
      +

      [Integer] +A more detailed context in which the ad appears. +See NativeContextSubtype

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var contextsubtype: ContextSubType?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + plcmttype + +
      +
      +
      +
      +
      +
      +

      [Recommended] +[Integer] +The design/format/layout of the ad unit being offered. +See NativePlacementType

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var plcmttype: PlacementType?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + plcmtcnt + +
      +
      +
      +
      +
      +
      +

      [Integer] +The number of identical placements in this Layout. Refer Section 8.1 Multiplacement Bid Requests for further detail.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var plcmtcnt: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + seq + +
      +
      +
      +
      +
      +
      +

      [Integer] +0 for the first ad, 1 for the second ad, and so on. +Note this would generally NOT be used in combination with plcmtcnt - +either you are auctioning multiple identical placements (in which case plcmtcnt>1, seq=0) +or you are holding separate auctions for distinct items in the feed (in which case plcmtcnt=1, seq=>=1)

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var seq: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + assets + +
      +
      +
      +
      +
      +
      +

      [Required] +An array of Asset Objects. Any objects bid response must comply with the array of elements expressed in the bid request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var assets: [NativeAsset]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + aurlsupport + +
      +
      +
      +
      +
      +
      +

      [Integer] +Whether the supply source / impression supports returning an assetsurl instead of an asset object. 0 or the absence of the field indicates no such support.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var aurlsupport: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + durlsupport + +
      +
      +
      +
      +
      +
      +

      [Integer] +Whether the supply source / impression supports returning a dco url instead of an asset object. 0 or the absence of the field indicates no such support. +Beta feature.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var durlsupport: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + eventtrackers + +
      +
      +
      +
      +
      +
      +

      Specifies what type of event objects tracking is supported - see Event Trackers Request Object

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var eventtrackers: [NativeEventTracker]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + privacy + +
      +
      +
      +
      +
      +
      +

      [Recommended] +[Integer] +Set to 1 when the native ad supports buyer-specific privacy notice. Set to 0 (or field absent) when the native ad doesn’t support custom privacy links or if support is unknown.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var privacy: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeMarkupRequestObject with default values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    NSCopying +

    +
    +
    +
      +
    • +
      + + + + copy(with:) + +
      +
      +
      +
      +
      +
      +

      Creates a copy of the current NativeMarkupRequestObject instance.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func copy(with zone: NSZone? = nil) -> Any
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + zone + + +
      +

      An optional zone for the copy operation.

      +
      +
      +
      +
      +

      Return Value

      +

      A copy of the NativeMarkupRequestObject instance.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    PBMJsonCodable +

    +
    +
    +
      +
    • +
      + + + + jsonDictionary + +
      +
      +
      +
      +
      +
      +

      Converts the NativeMarkupRequestObject instance to a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var jsonDictionary: [String : Any]? { get }
      + +
      +
      +
      +

      Return Value

      +

      A dictionary representation of the NativeMarkupRequestObject instance.

      +
      +
      +
      +
      • +
    • +
      + + + + toJsonString() + +
      +
      +
      +
      +
      +
      +

      Converts the NativeMarkupRequestObject instance to a JSON string.

      +
      +

      Throws

      + An error if the conversion to JSON string fails. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func toJsonString() throws -> String
      + +
      +
      +
      +

      Return Value

      +

      A JSON string representation of the NativeMarkupRequestObject instance.

      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeParameters.html b/docs/Classes/NativeParameters.html new file mode 100644 index 000000000..34e5390e6 --- /dev/null +++ b/docs/Classes/NativeParameters.html @@ -0,0 +1,646 @@ + + + + NativeParameters Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeParameters

    +
    +
    + + 
    @objcMembers
+public class NativeParameters : NSObject
    + +
    +
    +

    Represents parameters for a native ad request, including assets, event trackers, and configuration settings.

    + +
    +
    +
    +
      +
    • +
      + + + + assets + +
      +
      +
      +
      +
      +
      +

      An array of NativeAsset objects representing the assets required for the native ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var assets: [NativeAsset]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + eventtrackers + +
      +
      +
      +
      +
      +
      +

      An array of NativeEventTracker objects specifying the event tracking settings for the native ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var eventtrackers: [NativeEventTracker]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + version + +
      +
      +
      +
      +
      +
      +

      The version of the native ad specification being used. Defaults to “1.2”.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var version: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + context + +
      +
      +
      +
      +
      +
      +

      The context in which the ad appears. See ContextType for possible values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var context: ContextType?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + contextSubType + +
      +
      +
      +
      +
      +
      +

      A more detailed context in which the ad appears. See ContextSubType for possible values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var contextSubType: ContextSubType?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + placementType + +
      +
      +
      +
      +
      +
      +

      The design/format/layout of the ad unit being offered. See PlacementType for possible values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var placementType: PlacementType?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + placementCount + +
      +
      +
      +
      +
      +
      +

      The number of identical placements in the ad layout. Defaults to 1.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var placementCount: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + sequence + +
      +
      +
      +
      +
      +
      +

      The sequence number of the ad. Defaults to 0.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var sequence: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + asseturlsupport + +
      +
      +
      +
      +
      +
      +

      Indicates whether the supply source/impression supports returning an assetsurl instead of an asset object. +Defaults to 0, indicating no support.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var asseturlsupport: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + durlsupport + +
      +
      +
      +
      +
      +
      +

      Indicates whether the supply source/impression supports returning a dco URL instead of an asset object. +Defaults to 0, indicating no support.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var durlsupport: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + privacy + +
      +
      +
      +
      +
      +
      +

      Indicates whether the supply source/impression supports returning a dco URL instead of an asset object. +Defaults to 0, indicating no support.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var privacy: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      A placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeRequest.html b/docs/Classes/NativeRequest.html new file mode 100644 index 000000000..32494e5b3 --- /dev/null +++ b/docs/Classes/NativeRequest.html @@ -0,0 +1,910 @@ + + + + NativeRequest Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeRequest

    +
    +
    + + 
    public class NativeRequest : AdUnit
    + +
    +
    +

    A class representing a native request for original type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + version + +
      +
      +
      +
      +
      +
      +

      The version of the native ad specification being used. Defaults to “1.2” if not set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var version: String { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + context + +
      +
      +
      +
      +
      +
      +

      The context in which the ad appears. See ContextType for possible values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var context: ContextType? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + contextSubType + +
      +
      +
      +
      +
      +
      +

      A more detailed context in which the ad appears. See ContextSubType for possible values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var contextSubType: ContextSubType? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + placementType + +
      +
      +
      +
      +
      +
      +

      The design/format/layout of the ad unit being offered. See PlacementType for possible values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var placementType: PlacementType? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + placementCount + +
      +
      +
      +
      +
      +
      +

      The number of identical placements in the ad layout. Defaults to 1 if not set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var placementCount: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + sequence + +
      +
      +
      +
      +
      +
      +

      The sequence number of the ad. Defaults to 0 if not set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var sequence: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + assets + +
      +
      +
      +
      +
      +
      +

      An array of NativeAsset objects representing the assets required for the native ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var assets: [NativeAsset]? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + asseturlsupport + +
      +
      +
      +
      +
      +
      +

      Indicates whether the supply source/impression supports returning an assetsurl instead of an asset object. +Defaults to 0 if not set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var asseturlsupport: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + durlsupport + +
      +
      +
      +
      +
      +
      +

      Indicates whether the supply source/impression supports returning a dco URL instead of an asset object. +Defaults to 0 if not set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var durlsupport: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + eventtrackers + +
      +
      +
      +
      +
      +
      +

      An array of NativeEventTracker objects specifying the event tracking settings for the native ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var eventtrackers: [NativeEventTracker]? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + privacy + +
      +
      +
      +
      +
      +
      +

      Indicates whether the native ad supports a buyer-specific privacy notice. Defaults to 0 if not set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var privacy: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      A placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + configId + +
      +
      +
      +
      +
      +
      +

      The configuration ID for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var configId: String { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:) + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeRequest with a specified configuration ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a NativeRequest with a specified configuration ID, assets, and event trackers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configId: String, assets: [NativeAsset]? = nil, eventTrackers: [NativeEventTracker]? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + assets + + +
      +

      An optional array of NativeAsset objects.

      +
      +
      + + eventTrackers + + +
      +

      An optional array of NativeEventTracker objects.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addNativeAssets(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of native assets to the request. If assets already exist, they will be appended.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addNativeAssets(_ assets: [NativeAsset])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + assets + + +
      +

      An array of NativeAsset objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds an array of native event trackers to the request. If event trackers already exist, they will be appended.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addNativeEventTracker(_ eventTrackers: [NativeEventTracker])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + eventTrackers + + +
      +

      An array of NativeEventTracker objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Retrieves the native request object as a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getNativeRequestObject() -> [AnyHashable : Any]?
      + +
      +
      +
      +

      Return Value

      +

      A dictionary representation of the native request object, or nil if an error occurs.

      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/NativeTitle.html b/docs/Classes/NativeTitle.html new file mode 100644 index 000000000..f544200c5 --- /dev/null +++ b/docs/Classes/NativeTitle.html @@ -0,0 +1,475 @@ + + + + NativeTitle Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeTitle

    +
    +
    + + 
    @objcMembers
+public class NativeTitle : NSObject, JsonDecodable
    + +
    +
    +

    Represents the title element in a native ad, including optional text and length.

    + +
    +
    +
    +
      +
    • +
      + + + + text + +
      +
      +
      +
      +
      +
      +

      The text associated with the text element.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var text: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + length + +
      +
      +
      +
      +
      +
      +

      The length of the title being provided. +Required if using assetsurl/dcourl representation, optional if using embedded asset representation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var length: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(jsonDictionary:) + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeTitle object from a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(jsonDictionary: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + jsonDictionary + + +
      +

      A dictionary containing the JSON representation of the title.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes a NativeTitle object with default values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/PlacementType.html b/docs/Classes/PlacementType.html new file mode 100644 index 000000000..661bf822c --- /dev/null +++ b/docs/Classes/PlacementType.html @@ -0,0 +1,454 @@ + + + + PlacementType Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PlacementType

    +
    +
    + + 
    @objcMembers
+public class PlacementType : SingleContainerInt
    + +
    +
    +

    Represents different types of placements for native ads.

    + +
    +
    +
    +
      +
    • +
      + + + + FeedContent + +
      +
      +
      +
      +
      +
      +

      Placement type indicating the ad appears within feed content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let FeedContent: PlacementType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + AtomicContent + +
      +
      +
      +
      +
      +
      +

      Placement type indicating the ad appears within atomic content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let AtomicContent: PlacementType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + OutsideContent + +
      +
      +
      +
      +
      +
      +

      Placement type indicating the ad appears outside of content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let OutsideContent: PlacementType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + RecommendationWidget + +
      +
      +
      +
      +
      +
      +

      Placement type indicating the ad appears within a recommendation widget.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let RecommendationWidget: PlacementType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Placement type for custom placements not predefined in the standard.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Custom: PlacementType
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Prebid.html b/docs/Classes/Prebid.html new file mode 100644 index 000000000..396c9eb5a --- /dev/null +++ b/docs/Classes/Prebid.html @@ -0,0 +1,1589 @@ + + + + Prebid Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Prebid

    +
    +
    + + 
    @objcMembers
+public class Prebid : NSObject
    + +
    +
    +

    The Prebid class manages the configuration and initialization of the PrebidMobile SDK.

    + +
    +
    +
    +
    + + +
    + +

    Public Properties (SDK) +

    +
    +
    +
      +
    • +
      + + + + bidderNameAppNexus + +
      +
      +
      +
      +
      +
      +

      The name of the bidder for AppNexus.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let bidderNameAppNexus: String
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      The name of the bidder for Rubicon Project.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let bidderNameRubiconProject: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + timeoutUpdated + +
      +
      +
      +
      +
      +
      +

      Indicates whether the timeout value has been updated.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var timeoutUpdated: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidServerAccountId + +
      +
      +
      +
      +
      +
      +

      The Prebid Server account ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var prebidServerAccountId: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + pbsDebug + +
      +
      +
      +
      +
      +
      +

      Enables or disables debug mode. +ORTB: bidRequest.test

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var pbsDebug: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + customHeaders + +
      +
      +
      +
      +
      +
      +

      Custom HTTP headers to be sent with requests.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var customHeaders: [String : String]
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + storedBidResponses + +
      +
      +
      +
      +
      +
      +

      Stored bid responses identified by bidder names.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var storedBidResponses: [String : String]
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This property is set by the developer when he is willing to assign the assetID for Native ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var shouldAssignNativeAssetID: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + shareGeoLocation + +
      +
      +
      +
      +
      +
      +

      This property is set by the developer when he is willing to share the location for better ad targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var shareGeoLocation: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + logLevel + +
      +
      +
      +
      +
      +
      +

      Set the desidered verbosity of the logs

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var logLevel: LogLevel { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + externalUserIdArray + +
      +
      +
      +
      +
      +
      +

      Array containing objects that hold External UserId parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var externalUserIdArray: [ExternalUserId]
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + shared + +
      +
      +
      +
      +
      +
      +

      The singleton instance of the Prebid class.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let shared: Prebid
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + version + +
      +
      +
      +
      +
      +
      +

      The version of the PrebidMobile SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var version: String { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + omsdkVersion + +
      +
      +
      +
      +
      +
      +

      The version of the OM SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var omsdkVersion: String { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Properties (Prebid) +

    +
    +
    +
      +
    • +
      + + + + prebidServerHost + +
      +
      +
      +
      +
      +
      +

      The host for the Prebid Server.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var prebidServerHost: PrebidHost { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + customStatusEndpoint + +
      +
      +
      +
      +
      +
      +

      Custom status endpoint for the Prebid Server.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var customStatusEndpoint: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + timeoutMillis + +
      +
      +
      +
      +
      +
      +

      Timeout for Prebid requests in milliseconds.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var timeoutMillis: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + timeoutMillisDynamic + +
      +
      +
      +
      +
      +
      +

      Dynamic timeout value.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var timeoutMillisDynamic: NSNumber?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + storedAuctionResponse + +
      +
      +
      +
      +
      +
      +

      Stored auction response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var storedAuctionResponse: String?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Properties (SDK) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Indicates whether the PBS should cache the bid for the rendering API. +If the value is true the SDK will make the cache request in order to report +the impression event respectively to the legacy analytic setup.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var useCacheForReportingWithRenderingAPI: Bool
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Controls how long each creative has to load before it is considered a failure.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var creativeFactoryTimeout: TimeInterval
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Controls how long video and interstitial creatives have to load before it is considered a failure.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var creativeFactoryTimeoutPreRenderContent: TimeInterval
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Controls whether to use PrebidMobile’s in-app browser or the Safari App for displaying ad clickthrough content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var useExternalClickthroughBrowser: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + impClickbrowserType + +
      +
      +
      +
      +
      +
      +

      Indicates the type of browser opened upon clicking the creative in an app, where embedded = 0, native = 1. +Describes an OpenRTB imp.clickbrowser attribute.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var impClickbrowserType: ClickbrowserType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + debugLogFileEnabled + +
      +
      +
      +
      +
      +
      +

      If set to true, the output of PrebidMobile’s internal logger is written to a text file. This can be helpful for debugging. Defaults to false.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var debugLogFileEnabled: Bool { get set }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      If true, the SDK will periodically try to listen for location updates in order to request location-based ads.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var locationUpdatesEnabled: Bool { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + includeWinners + +
      +
      +
      +
      +
      +
      +

      If true, the sdk will add includewinners flag inside the targeting object described in PBS Documentation

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var includeWinners: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + includeBidderKeys + +
      +
      +
      +
      +
      +
      +

      If true, the sdk will add includebidderkeys flag inside the targeting object described in PBS Documentation

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var includeBidderKeys: Bool
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Sets a custom Prebid Server URL.

      +
      +

      Throws

      + An error if setting the custom host URL fails. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setCustomPrebidServer(url: String) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + url + + +
      +

      The custom Prebid Server URL.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Stored Bid Response +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Adds a stored bid response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addStoredBidResponse(bidder: String, responseId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + bidder + + +
      +

      The name of the bidder.

      +
      +
      + + responseId + + +
      +

      The response ID.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all stored bid responses.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearStoredBidResponses()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Retrieves stored bid responses.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getStoredBidResponses() -> [[String : String]]?
      + +
      +
      +
      +

      Return Value

      +

      An array of dictionaries containing stored bid responses, or nil if there are none.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Custom Headers +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Adds a custom HTTP header.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addCustomHeader(name: String, value: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + name + + +
      +

      The name of the header.

      +
      +
      + + value + + +
      +

      The value of the header.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearCustomHeaders() + +
      +
      +
      +
      +
      +
      +

      Clears all custom HTTP headers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearCustomHeaders()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + initializeSDK(_:_:) + +
      +
      +
      +
      +
      +
      +

      Initializes PrebidMobile SDK.

      + +

      Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. +If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. +The host value is obtained from Prebid.shared.prebidServerHost.

      + +

      Checks the version of GMA SDK. If the version is not supported - logs warning.

      + +

      Use this SDK initializer if you’re using PrebidMobile with GMA SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static func initializeSDK(_ gadMobileAdsObject: AnyObject? = nil, _ completion: PrebidInitializationCallback? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + gadMobileAdsObject + + +
      +

      GADMobileAds object

      +
      +
      + + completion + + +
      +

      returns initialization status and optional error

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes PrebidMobile SDK.

      + +

      Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. +If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. +The host value is obtained from Prebid.shared.prebidServerHost.

      + +

      Checks the version of GMA SDK. If the version is not supported - logs warning.

      + +

      Use this SDK initializer if you’re using PrebidMobile with GMA SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static func initializeSDK(gadMobileAdsVersion: String? = nil, _ completion: PrebidInitializationCallback? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + gadMobileAdsVersion + + +
      +

      GADMobileAds version string, use GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber) to get it

      +
      +
      + + completion + + +
      +

      returns initialization status and optional error

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + initializeSDK(_:) + +
      +
      +
      +
      +
      +
      +

      Initializes PrebidMobile SDK.

      + +

      Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. +If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. +The host value is obtained from Prebid.shared.prebidServerHost.

      + +

      Use this SDK initializer if you’re using PrebidMobile without GMA SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static func initializeSDK(_ completion: PrebidInitializationCallback? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      returns initialization status and optional error

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/PrebidAdUnit.html b/docs/Classes/PrebidAdUnit.html new file mode 100644 index 000000000..53537e0c0 --- /dev/null +++ b/docs/Classes/PrebidAdUnit.html @@ -0,0 +1,634 @@ + + + + PrebidAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PrebidAdUnit

    +
    +
    + + 
    @objcMembers
+public class PrebidAdUnit : NSObject
    + +
    +
    +

    Multiformat ad unit. Built for original API.

    + +
    +
    +
    +
      +
    • +
      + + + + pbAdSlot + +
      +
      +
      +
      +
      +
      +

      The ad slot identifier for the Prebid ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var pbAdSlot: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new PrebidAdUnit with the given configuration ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request for the specified ad object and request config. Setups targeting keywords into the adObject.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchDemand(adObject: AnyObject, request: PrebidRequest,
+                        completion: @escaping (BidInfo) -> Void)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + adObject + + +
      +

      The ad object to fetch demand for.

      +
      +
      + + request + + +
      +

      The PrebidRequest containing the demand request parameters.

      +
      +
      + + completion + + +
      +

      A closure to be called with the BidInfo result.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request for the specified request config.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchDemand(request: PrebidRequest, completion: @escaping (BidInfo) -> Void)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + request + + +
      +

      The PrebidRequest containing the demand request parameters.

      +
      +
      + + completion + + +
      +

      A closure to be called with the BidInfo result.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Auto refresh API +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method allows to set the auto refresh period for the demand

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAutoRefreshMillis(time: Double)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + time + + +
      +

      refresh time interval

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + stopAutoRefresh() + +
      +
      +
      +
      +
      +
      +

      This method stops the auto refresh of demand

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func stopAutoRefresh()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + resumeAutoRefresh() + +
      +
      +
      +
      +
      +
      +

      This method resumes the auto refresh of demand

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func resumeAutoRefresh()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/PrebidRequest.html b/docs/Classes/PrebidRequest.html new file mode 100644 index 000000000..dcecea00c --- /dev/null +++ b/docs/Classes/PrebidRequest.html @@ -0,0 +1,1065 @@ + + + + PrebidRequest Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PrebidRequest

    +
    +
    + + 
    @objcMembers
+public class PrebidRequest : NSObject
    + +
    +
    +

    Class that contains properties and methods to configure Prebid request.

    + +
    +
    +
    +
    + + +
    + +

    Private properties +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a new PrebidRequest with the given parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(bannerParameters: BannerParameters? = nil, videoParameters: VideoParameters? = nil,
+            nativeParameters: NativeParameters? = nil, isInterstitial: Bool = false, isRewarded: Bool = false)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + +
      + + bannerParameters + + +
      +

      The banner parameters for the ad request.

      +
      +
      + + videoParameters + + +
      +

      The video parameters for the ad request.

      +
      +
      + + nativeParameters + + +
      +

      The native parameters for the ad request.

      +
      +
      + + isInterstitial + + +
      +

      Indicates if the request is for an interstitial ad.

      +
      +
      + + isRewarded + + +
      +

      Indicates if the request is for a rewarded ad.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    GPID +

    +
    +
    +
      +
    • +
      + + + + setGPID(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the GPID for the ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setGPID(_ gpid: String?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + gpid + + +
      +

      The GPID to set.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    adunit ext data aka inventory data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & value for adunit targeting +if the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & values for adunit targeting +the values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific ext data keyword & values set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all ext data set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    adunit ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method allows to remove specific keyword from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content for the ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAppContent(_ appContentObject: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContentObject + + +
      +

      The PBMORTBAppContent to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the app content for the ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds data to the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      The array of PBMORTBContentData to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes specific data from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppContentData(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The PBMORTBContentData to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContentData() + +
      +
      +
      +
      +
      +
      +

      Clears all data from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContentData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds user data to the ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      The array of PBMORTBContentData to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes specific user data from the ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The PBMORTBContentData to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data from the ad request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/RewardedAdUnit.html b/docs/Classes/RewardedAdUnit.html new file mode 100644 index 000000000..df5bbba2e --- /dev/null +++ b/docs/Classes/RewardedAdUnit.html @@ -0,0 +1,1001 @@ + + + + RewardedAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    RewardedAdUnit

    +
    +
    + + 
    @objc
+public class RewardedAdUnit: BaseInterstitialAdUnit,
+                             RewardedEventInteractionDelegate
    + +
    +
    +

    Represents an rewarded ad unit. Built for rendering type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + reward + +
      +
      +
      +
      +
      +
      +

      The reward object for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var reward: NSObject? { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Lifecycle +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a RewardedAdUnit with the given configuration ID and event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public convenience init(configID: String, eventHandler: AnyObject)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configID + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + eventHandler + + +
      +

      The event handler for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configID:) + +
      +
      +
      +
      +
      +
      +

      Initializes a RewardedAdUnit with the given configuration ID and a default event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public convenience init(configID: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configID + + +
      +

      The configuration ID for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    PBMRewardedEventDelegate +

    +
    +
    +
      +
    • +
      + + + + userDidEarnReward(_:) + +
      +
      +
      +
      +
      +
      +

      Called when the user earns a reward.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func userDidEarnReward(_ reward: NSObject?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + reward + + +
      +

      The reward object associated with the event.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    BaseInterstitialAdUnitProtocol protocol +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Called when the interstitial ad is closed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func interstitialControllerDidCloseAd(_ interstitialController: InterstitialController)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + interstitialController + + +
      +

      The controller managing the interstitial ad.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Protected overrides +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Called when the ad unit receives an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didReceiveAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad unit fails to receive an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didFailToReceiveAd(with error: Error?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + error + + +
      +

      The error describing the failure.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad unit will present an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_willPresentAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad unit dismisses an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didDismissAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad unit will leave the application.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_willLeaveApplication()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad unit is clicked.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didClickAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns whether the event handler is ready.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_isReady() -> Bool
      + +
      +
      +
      +

      Return Value

      +

      A boolean indicating if the event handler is ready.

      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the loading delegate for the event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_setLoadingDelegate(_ loadingDelegate: NSObject?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + loadingDelegate + + +
      +

      The loading delegate to set.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the interaction delegate for the event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_setInteractionDelegate()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Requests an ad with the given bid response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_requestAd(with bidResponse: BidResponse?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + bidResponse + + +
      +

      The bid response to use for the ad request.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Shows the ad from the specified view controller.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_show(from controller: UIViewController?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + controller + + +
      +

      The view controller from which to present the ad.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Tracks the impression for the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_trackImpression()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/RewardedVideoAdUnit.html b/docs/Classes/RewardedVideoAdUnit.html new file mode 100644 index 000000000..f50083c92 --- /dev/null +++ b/docs/Classes/RewardedVideoAdUnit.html @@ -0,0 +1,494 @@ + + + + RewardedVideoAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    RewardedVideoAdUnit

    +
    +
    + + 
    public class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
    + +
    +
    +

    Represents an rewarded ad unit for original type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + parameters + +
      +
      +
      +
      +
      +
      +

      Deprecated property for video parameters.

      +
      +

      Note

      + This property is deprecated. Please use videoParameters instead. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This property is deprecated. Please, use videoParameters instead.")
+public var parameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      Property for video parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var videoParameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:) + +
      +
      +
      +
      +
      +
      +

      Initializes a RewardedVideoAdUnit with the given configuration ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a RewardedVideoAdUnit with the given configuration ID and minimum size percentages.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configId: String, minWidthPerc: Int, minHeightPerc: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + minWidthPerc + + +
      +

      The minimum width percentage for the ad unit.

      +
      +
      + + minHeightPerc + + +
      +

      The minimum height percentage for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Signals.html b/docs/Classes/Signals.html new file mode 100644 index 000000000..c959c3000 --- /dev/null +++ b/docs/Classes/Signals.html @@ -0,0 +1,514 @@ + + + + Signals Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Signals

    +
    +
    + + 
    public class Signals : NSObject
    + +
    +
    +

    A class containing constants related to OpenRTB signals.

    + +

    This class provides static constants and values representing different +API frameworks, playback methods, protocols, start delays, and video +placement types as defined in the OpenRTB specification.

    + +
    +
    +
    +
      +
    • +
      + + + + Api + +
      +
      +
      +
      +
      +
      +

      OpenRTB - API Frameworks

      +
       | Value | Description |
+ |-------|-------------|
+ | 1     | VPAID 1.0   |
+ | 2     | VPAID 2.0   |
+ | 3     | MRAID-1     |
+ | 4     | ORMMA       |
+ | 5     | MRAID-2     |
+ | 6     | MRAID-3     |
+ | 7     | OMID-1      |
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBApi)
+public class Api : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + PlaybackMethod + +
      +
      +
      +
      +
      +
      +

      OpenRTB - Playback Methods

      +
      | Value | Description                                              |
+|-------|----------------------------------------------------------|
+| 1     | Initiates on Page Load with Sound On                     |
+| 2     | Initiates on Page Load with Sound Off by Default         |
+| 3     | Initiates on Click with Sound On                         |
+| 4     | Initiates on Mouse-Over with Sound On                    |
+| 5     | Initiates on Entering Viewport with Sound On             |
+| 6     | Initiates on Entering Viewport with Sound Off by Default |
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBPlaybackMethod)
+public class PlaybackMethod : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Protocols + +
      +
      +
      +
      +
      +
      +

      OpenRTB - Protocols

      +
      | Value | Description       |
+|-------|-------------------|
+| 1     | VAST 1.0          |
+| 2     | VAST 2.0          |
+| 3     | VAST 3.0          |
+| 4     | VAST 1.0 Wrapper  |
+| 5     | VAST 2.0 Wrapper  |
+| 6     | VAST 3.0 Wrapper  |
+| 7     | VAST 4.0          |
+| 8     | VAST 4.0 Wrapper  |
+| 9     | DAAST 1.0         |
+| 10    | DAAST 1.0 Wrapper |
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBProtocols)
+public class Protocols : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + StartDelay + +
      +
      +
      +
      +
      +
      +

      OpenRTB - Start Delay

      +
      | Value | Description                                      |
+|-------|--------------------------------------------------|
+| > 0   | Mid-Roll (value indicates start delay in second) |
+| 0     | Pre-Roll                                         |
+| -1    | Generic Mid-Roll                                 |
+| -2    | Generic Post-Roll                                |
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBStartDelay)
+public class StartDelay : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Placement + +
      +
      +
      +
      +
      +
      +

      OpenRTB - Video Placement Types

      +
      | Value | Description                  |
+|-------|------------------------------|
+| 1     | In-Stream                    |
+| 2     | In-Banner                    |
+| 3     | In-Article                   |
+| 4     | In-Feed                      |
+| 5     | Interstitial/Slider/Floating |
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBPlacement)
+public class Placement : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Signals/Api.html b/docs/Classes/Signals/Api.html new file mode 100644 index 000000000..caaa75f78 --- /dev/null +++ b/docs/Classes/Signals/Api.html @@ -0,0 +1,527 @@ + + + + Api Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Api

    +
    +
    + + 
    @objc(PBApi)
+public class Api : SingleContainerInt
    + +
    +
    +

    OpenRTB - API Frameworks

    +
     | Value | Description |
+ |-------|-------------|
+ | 1     | VPAID 1.0   |
+ | 2     | VPAID 2.0   |
+ | 3     | MRAID-1     |
+ | 4     | ORMMA       |
+ | 5     | MRAID-2     |
+ | 6     | MRAID-3     |
+ | 7     | OMID-1      |
+
    + +
    +
    +
    +
      +
    • +
      + + + + VPAID_1 + +
      +
      +
      +
      +
      +
      +

      VPAID 1.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VPAID_1: Signals.Api
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VPAID_2 + +
      +
      +
      +
      +
      +
      +

      VPAID 2.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VPAID_2: Signals.Api
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + MRAID_1 + +
      +
      +
      +
      +
      +
      +

      MRAID-1

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let MRAID_1: Signals.Api
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ORMMA + +
      +
      +
      +
      +
      +
      +

      ORMMA

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let ORMMA: Signals.Api
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + MRAID_2 + +
      +
      +
      +
      +
      +
      +

      MRAID-2

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let MRAID_2: Signals.Api
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + MRAID_3 + +
      +
      +
      +
      +
      +
      +

      MRAID-3

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let MRAID_3: Signals.Api
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + OMID_1 + +
      +
      +
      +
      +
      +
      +

      OMID-1

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let OMID_1: Signals.Api
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Signals/Placement.html b/docs/Classes/Signals/Placement.html new file mode 100644 index 000000000..94e8b4dfe --- /dev/null +++ b/docs/Classes/Signals/Placement.html @@ -0,0 +1,553 @@ + + + + Placement Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Placement

    +
    +
    + + 
    @objc(PBPlacement)
+public class Placement : SingleContainerInt
    + +
    +
    +

    OpenRTB - Video Placement Types

    +
    | Value | Description                  |
+|-------|------------------------------|
+| 1     | In-Stream                    |
+| 2     | In-Banner                    |
+| 3     | In-Article                   |
+| 4     | In-Feed                      |
+| 5     | Interstitial/Slider/Floating |
+
    + +
    +
    +
    +
      +
    • +
      + + + + InStream + +
      +
      +
      +
      +
      +
      +

      In-Stream

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let InStream: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + InBanner + +
      +
      +
      +
      +
      +
      +

      In-Banner

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let InBanner: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + InArticle + +
      +
      +
      +
      +
      +
      +

      In-Article

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let InArticle: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + InFeed + +
      +
      +
      +
      +
      +
      +

      In-Feed

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let InFeed: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Interstitial + +
      +
      +
      +
      +
      +
      +

      Interstitial

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Interstitial: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Slider + +
      +
      +
      +
      +
      +
      +

      Slider

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Slider: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Floating + +
      +
      +
      +
      +
      +
      +

      Floating

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Floating: Signals.Placement
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Helper function

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static func getPlacementByRawValue(_ value: Int) -> Signals.Placement?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Signals/PlaybackMethod.html b/docs/Classes/Signals/PlaybackMethod.html new file mode 100644 index 000000000..aee7a98a2 --- /dev/null +++ b/docs/Classes/Signals/PlaybackMethod.html @@ -0,0 +1,498 @@ + + + + PlaybackMethod Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PlaybackMethod

    +
    +
    + + 
    @objc(PBPlaybackMethod)
+public class PlaybackMethod : SingleContainerInt
    + +
    +
    +

    OpenRTB - Playback Methods

    +
    | Value | Description                                              |
+|-------|----------------------------------------------------------|
+| 1     | Initiates on Page Load with Sound On                     |
+| 2     | Initiates on Page Load with Sound Off by Default         |
+| 3     | Initiates on Click with Sound On                         |
+| 4     | Initiates on Mouse-Over with Sound On                    |
+| 5     | Initiates on Entering Viewport with Sound On             |
+| 6     | Initiates on Entering Viewport with Sound Off by Default |
+
    + +
    +
    +
    +
      +
    • +
      + + + + AutoPlaySoundOn + +
      +
      +
      +
      +
      +
      +

      Initiates on Page Load with Sound On

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let AutoPlaySoundOn: Signals.PlaybackMethod
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + AutoPlaySoundOff + +
      +
      +
      +
      +
      +
      +

      Initiates on Page Load with Sound Off by Default

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let AutoPlaySoundOff: Signals.PlaybackMethod
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ClickToPlay + +
      +
      +
      +
      +
      +
      +

      Initiates on Click with Sound On

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let ClickToPlay: Signals.PlaybackMethod
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + MouseOver + +
      +
      +
      +
      +
      +
      +

      Initiates on Mouse-Over with Sound On

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let MouseOver: Signals.PlaybackMethod
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + EnterSoundOn + +
      +
      +
      +
      +
      +
      +

      Initiates on Entering Viewport with Sound On

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let EnterSoundOn: Signals.PlaybackMethod
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + EnterSoundOff + +
      +
      +
      +
      +
      +
      +

      Initiates on Entering Viewport with Sound Off by Default

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let EnterSoundOff: Signals.PlaybackMethod
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Signals/Protocols.html b/docs/Classes/Signals/Protocols.html new file mode 100644 index 000000000..05f332c5d --- /dev/null +++ b/docs/Classes/Signals/Protocols.html @@ -0,0 +1,614 @@ + + + + Protocols Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Protocols

    +
    +
    + + 
    @objc(PBProtocols)
+public class Protocols : SingleContainerInt
    + +
    +
    +

    OpenRTB - Protocols

    +
    | Value | Description       |
+|-------|-------------------|
+| 1     | VAST 1.0          |
+| 2     | VAST 2.0          |
+| 3     | VAST 3.0          |
+| 4     | VAST 1.0 Wrapper  |
+| 5     | VAST 2.0 Wrapper  |
+| 6     | VAST 3.0 Wrapper  |
+| 7     | VAST 4.0          |
+| 8     | VAST 4.0 Wrapper  |
+| 9     | DAAST 1.0         |
+| 10    | DAAST 1.0 Wrapper |
+
    + +
    +
    +
    +
      +
    • +
      + + + + VAST_1_0 + +
      +
      +
      +
      +
      +
      +

      VAST 1.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_1_0: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_2_0 + +
      +
      +
      +
      +
      +
      +

      VAST 2.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_2_0: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_3_0 + +
      +
      +
      +
      +
      +
      +

      VAST 3.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_3_0: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_1_0_Wrapper + +
      +
      +
      +
      +
      +
      +

      VAST 1.0 Wrapper

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_1_0_Wrapper: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_2_0_Wrapper + +
      +
      +
      +
      +
      +
      +

      VAST 2.0 Wrapper

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_2_0_Wrapper: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_3_0_Wrapper + +
      +
      +
      +
      +
      +
      +

      VAST 3.0 Wrapper

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_3_0_Wrapper: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_4_0 + +
      +
      +
      +
      +
      +
      +

      VAST 4.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_4_0: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VAST_4_0_Wrapper + +
      +
      +
      +
      +
      +
      +

      VAST 4.0 Wrapper

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let VAST_4_0_Wrapper: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + DAAST_1_0 + +
      +
      +
      +
      +
      +
      +

      DAAST 1.0

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let DAAST_1_0: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + DAAST_1_0_WRAPPER + +
      +
      +
      +
      +
      +
      +

      DAAST 1.0 Wrapper

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let DAAST_1_0_WRAPPER: Signals.Protocols
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Signals/StartDelay.html b/docs/Classes/Signals/StartDelay.html new file mode 100644 index 000000000..f781fe6ea --- /dev/null +++ b/docs/Classes/Signals/StartDelay.html @@ -0,0 +1,412 @@ + + + + StartDelay Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    StartDelay

    +
    +
    + + 
    @objc(PBStartDelay)
+public class StartDelay : SingleContainerInt
    + +
    +
    +

    OpenRTB - Start Delay

    +
    | Value | Description                                      |
+|-------|--------------------------------------------------|
+| > 0   | Mid-Roll (value indicates start delay in second) |
+| 0     | Pre-Roll                                         |
+| -1    | Generic Mid-Roll                                 |
+| -2    | Generic Post-Roll                                |
+
    + +
    +
    +
    +
      +
    • +
      + + + + PreRoll + +
      +
      +
      +
      +
      +
      +

      Pre-Roll

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let PreRoll: Signals.StartDelay
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + GenericMidRoll + +
      +
      +
      +
      +
      +
      +

      Generic Mid-Roll

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let GenericMidRoll: Signals.StartDelay
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + GenericPostRoll + +
      +
      +
      +
      +
      +
      +

      Generic Post-Roll

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let GenericPostRoll: Signals.StartDelay
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SingleContainerInt.html b/docs/Classes/SingleContainerInt.html new file mode 100644 index 000000000..0b6a2bf60 --- /dev/null +++ b/docs/Classes/SingleContainerInt.html @@ -0,0 +1,453 @@ + + + + SingleContainerInt Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SingleContainerInt

    +
    +
    + + 
    public class SingleContainerInt : NSObject, ExpressibleByIntegerLiteral
    + +
    +
    +

    Undocumented

    + +
    +
    +
    +
      +
    • +
      + + + + IntegerLiteralType + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public typealias IntegerLiteralType = Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + value + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public let value: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(integerLiteral:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public required init(integerLiteral value: Int)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isEqual(_:) + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      override public func isEqual(_ object: Any?) -> Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + hash + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      override public var hash: Int { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Targeting.html b/docs/Classes/Targeting.html new file mode 100644 index 000000000..cfbf2e935 --- /dev/null +++ b/docs/Classes/Targeting.html @@ -0,0 +1,3326 @@ + + + + Targeting Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Targeting

    +
    +
    + + 
    @objcMembers
+public class Targeting : NSObject
    + +
    +
    +

    A class that manages targeting information for ads.

    + +

    This class provides properties and methods for setting and retrieving +user-specific targeting information, such as user ID, gender, and custom +data. It also includes details for OMID (Open Measurement Interface Definition) +partner and supports managing user identity links and custom extensions.

    + +
    +
    +
    +
      +
    • +
      + + + + shared + +
      +
      +
      +
      +
      +
      +

      A shared instance of the Targeting class.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static var shared: Targeting
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    OMID Partner +

    +
    +
    +
      +
    • +
      + + + + omidPartnerName + +
      +
      +
      +
      +
      +
      +

      The name of the OMID partner.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var omidPartnerName: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + omidPartnerVersion + +
      +
      +
      +
      +
      +
      +

      The version of the OMID partner.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var omidPartnerVersion: String?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Information +

    +
    +
    +
      +
    • +
      + + + + yearOfBirth + +
      +
      +
      +
      +
      +
      +

      Indicates user birth year.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var yearOfBirth: Int { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + setYearOfBirth(yob:) + +
      +
      +
      +
      +
      +
      +

      This method set the year of birth value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setYearOfBirth(yob: Int)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getYearOfBirth() + +
      +
      +
      +
      +
      +
      +

      Objective C API

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getYearOfBirth() -> NSNumber
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearYearOfBirth() + +
      +
      +
      +
      +
      +
      +

      This method clears year of birth value set by the application developer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearYearOfBirth()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + userGender + +
      +
      +
      +
      +
      +
      +

      Indicates the end-user’s gender.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var userGender: Gender { get set }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      String representation of the users gender, +where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown)

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func userGenderDescription() -> String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + userID + +
      +
      +
      +
      +
      +
      +

      Indicates the customer-provided user ID, if different from the Device ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var userID: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + buyerUID + +
      +
      +
      +
      +
      +
      +

      Buyer-specific ID for the user as mapped by the exchange for the buyer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var buyerUID: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + userCustomData + +
      +
      +
      +
      +
      +
      +

      Optional feature to pass bidder data that was set in the +exchange’s cookie. The string must be in base85 cookie safe +characters and be in any format. Proper JSON encoding must +be used to include “escaped” quotation marks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var userCustomData: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + eids + +
      +
      +
      +
      +
      +
      +

      Placeholder for User Identity Links. +The data from this property will be added to usr.ext.eids

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var eids: [[String : AnyHashable]]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + userExt + +
      +
      +
      +
      +
      +
      +

      Placeholder for exchange-specific extensions to OpenRTB.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var userExt: [String : AnyHashable]?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    COPPA +

    +
    +
    +
      +
    • +
      + + + + coppa + +
      +
      +
      +
      +
      +
      +

      Objective C analog of subjectToCOPPA

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var coppa: NSNumber? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + subjectToCOPPA + +
      +
      +
      +
      +
      +
      +

      Integer flag indicating if this request is subject to the COPPA regulations +established by the USA FTC, where 0 = no, 1 = yes

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var subjectToCOPPA: Bool? { get set }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    GDPR +

    +
    +
    +
      +
    • +
      + + + + subjectToGDPR + +
      +
      +
      +
      +
      +
      +

      The boolean value set by the user to collect user data

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var subjectToGDPR: Bool? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + setSubjectToGDPR(_:) + +
      +
      +
      +
      +
      +
      +

      Objective-C API

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setSubjectToGDPR(_ newValue: NSNumber?)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getSubjectToGDPR() + +
      +
      +
      +
      +
      +
      +

      Objective-C API

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getSubjectToGDPR() -> NSNumber?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    GDPR Consent +

    +
    +
    +
      +
    • +
      + + + + gdprConsentString + +
      +
      +
      +
      +
      +
      +

      The consent string for sending the GDPR consent

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var gdprConsentString: String? { get set }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    TCFv2 +

    +
    +
    +
      +
    • +
      + + + + purposeConsents + +
      +
      +
      +
      +
      +
      +

      The consent string for purposes consent as per TCFv2.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var purposeConsents: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Purpose 1 - Store and/or access information on a device

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getDeviceAccessConsent() -> Bool?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns whether the user has consented to access device data as an NSNumber.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getDeviceAccessConsentObjc() -> NSNumber?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns the user’s consent for a specific purpose by index.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getPurposeConsent(index: Int) -> Bool?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Checks if access to device data is allowed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func isAllowedAccessDeviceData() -> Bool
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    External User Ids +

    +
    +
    +
      +
    • +
      + + + + externalUserIds + +
      +
      +
      +
      +
      +
      +

      Array of external user IDs.

      + +

      This property holds the external user IDs associated with the user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var externalUserIds: [ExternalUserId]
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to save External User Id in the User Defaults

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func storeExternalUserId(_ externalUserId: ExternalUserId)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to get All External User Ids from User Defaults

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchStoredExternalUserIds() -> [ExternalUserId]?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to get External User Id from User Defaults by passing respective ‘source’ string as param

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchStoredExternalUserId(_ source: String) -> ExternalUserId?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific External User Id from User Defaults by passing respective ‘source’ string as param

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeStoredExternalUserId(_ source: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove all the External User Ids from User Defaults

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeStoredExternalUserIds()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getExternalUserIds() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getExternalUserIds() -> [[AnyHashable : Any]]?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Application Information +

    +
    +
    +
      +
    • +
      + + + + contentUrl + +
      +
      +
      +
      +
      +
      +

      This is the deep-link URL for the app screen that is displaying the ad. This can be an iOS universal link.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var contentUrl: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + publisherName + +
      +
      +
      +
      +
      +
      +

      App’s publisher name.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var publisherName: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + sourceapp + +
      +
      +
      +
      +
      +
      +

      ID of publisher app in Apple’s App Store.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var sourceapp: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + storeURL + +
      +
      +
      +
      +
      +
      +

      App store URL for an installed app

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var storeURL: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + domain + +
      +
      +
      +
      +
      +
      +

      Domain name of the app

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var domain: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + itunesID + +
      +
      +
      +
      +
      +
      +

      The itunes app id for targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var itunesID: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + location + +
      +
      +
      +
      +
      +
      +

      The application location for targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var location: CLLocation?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + locationPrecision + +
      +
      +
      +
      +
      +
      +

      The application location precision for targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var locationPrecision: Int?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Objective-C API

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setLocationPrecision(_ newValue: NSNumber?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Objective-C API

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getLocationPrecision() -> NSNumber?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Location and connection information +

    +
    +
    +
      +
    • +
      + + + + coordinate + +
      +
      +
      +
      +
      +
      +

      CLLocationCoordinate2D. +See CoreLocation framework documentation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var coordinate: NSValue?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • +
      + + + + addParam(_:withName:) + +
      +
      +
      +
      +
      +
      +

      Adds a parameter to the parameter dictionary with a specified name.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addParam(_ value: String, withName: String?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + value + + +
      +

      The value of the parameter.

      +
      +
      + + withName + + +
      +

      The name of the parameter. If nil, the parameter is not added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setCustomParams(_:) + +
      +
      +
      +
      +
      +
      +

      Sets custom parameters by adding each key-value pair to the parameter dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setCustomParams(_ params: [String : String]?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + params + + +
      +

      A dictionary of parameters to set. If nil, no parameters are added.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds a custom parameter to the parameter dictionary with a prefixed name.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addCustomParam(_ value: String, withName: String?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + value + + +
      +

      The value of the custom parameter.

      +
      +
      + + withName + + +
      +

      The name of the custom parameter. If nil, the parameter is not added.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Store location in the user’s section

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setLatitude(_ latitude: Double, longitude: Double)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Access Control List (ext.prebid.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Adds a bidder to the access control list.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addBidderToAccessControlList(_ bidderName: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + bidderName + + +
      +

      The name of the bidder to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a bidder from the access control list.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeBidderFromAccessControlList(_ bidderName: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + bidderName + + +
      +

      The name of the bidder to remove.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all bidders from the access control list.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAccessControlList()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Retrieves the current access control list.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getAccessControlList() -> [String]
      + +
      +
      +
      +

      Return Value

      +

      An array of bidder names in the access control list.

      +
      +
      +
      +
      • +
    • +
      + + + + accessControlList + +
      +
      +
      +
      +
      +
      +

      Access control list for external use.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var accessControlList: [String] { get }
      + +
      +
      +
      +

      Return Value

      +

      An array of bidder names in the access control list.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Global User Data (user.ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Adds user data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserData(key: String, value: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the user data.

      +
      +
      + + value + + +
      +

      The value to add for the specified key.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Updates user data for a specified key with a new set of values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateUserData(key: String, value: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the user data.

      +
      +
      + + value + + +
      +

      The set of values to update for the specified key.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(for:) + +
      +
      +
      +
      +
      +
      +

      Removes user data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserData(for key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + key + + +
      +

      The key for the user data to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getUserData() + +
      +
      +
      +
      +
      +
      +

      Retrieves all user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getUserData() -> [String : [String]]
      + +
      +
      +
      +

      Return Value

      +

      A dictionary mapping keys to arrays of values.

      +
      +
      +
      +
      • +
    • +
      + + + + userDataDictionary + +
      +
      +
      +
      +
      +
      +

      User data dictionary for external use.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var userDataDictionary: [String : [String]] { get }
      + +
      +
      +
      +

      Return Value

      +

      A dictionary mapping keys to arrays of values.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Global User Keywords (user.keywords) +

    +
    +
    +
      +
    • +
      + + + + addUserKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Adds a user keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserKeyword(_ newElement: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElement + + +
      +

      The keyword to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addUserKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      Adds multiple user keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElements + + +
      +

      A set of keywords to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a user keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserKeyword(_ element: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + element + + +
      +

      The keyword to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserKeywords() + +
      +
      +
      +
      +
      +
      +

      Clears all user keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getUserKeywords() + +
      +
      +
      +
      +
      +
      +

      Retrieves all user keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getUserKeywords() -> [String]
      + +
      +
      +
      +

      Return Value

      +

      An array of user keywords.

      +
      +
      +
      +
      • +
    • +
      + + + + userKeywords + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use getUserKeywords method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This property is deprecated. Please, use getUserKeywords method instead.")
+public var userKeywords: [String] { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Global Data (app.ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Deprecated. Use addAppExtData method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addAppExtData method instead.")
+public func addContextData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Deprecated. Use updateAppExtData method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateAppExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Deprecated. Use removeAppExtData method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeAppExtData method instead.")
+public func removeContextData(for key: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use clearAppExtData method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearAppExtData method instead.")
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getContextData() + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use getAppExtData method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use getAppExtData method instead.")
+public func getContextData() -> [String : [String]]
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + contextDataDictionary + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use getAppExtData method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This property is deprecated. Please, use getAppExtData method instead.")
+public var contextDataDictionary: [String : [String]] { get }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds application-specific data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppExtData(key: String, value: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the application data.

      +
      +
      + + value + + +
      +

      The value to add for the specified key.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Updates application-specific data for a specified key with a new set of values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateAppExtData(key: String, value: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the application data.

      +
      +
      + + value + + +
      +

      The set of values to update for the specified key.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes application-specific data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppExtData(for key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + key + + +
      +

      The key for the application data to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppExtData() + +
      +
      +
      +
      +
      +
      +

      Clears all application-specific data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppExtData()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getAppExtData() + +
      +
      +
      +
      +
      +
      +

      Retrieves all application-specific data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getAppExtData() -> [String : [String]]
      + +
      +
      +
      +

      Return Value

      +

      A dictionary mapping keys to arrays of values.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Global Keywords (app.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use addAppKeyword method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addAppKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Deprecated. Use addAppKeywords method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addAppKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Deprecated. Use removeAppKeyword method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeAppKeyword method instead.")
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Deprecated. Use clearAppKeywords method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearAppKeywords method instead.")
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getContextKeywords() + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use getAppKeywords method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use getAppKeywords method instead.")
+public func getContextKeywords() -> [String]
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + contextKeywords + +
      +
      +
      +
      +
      +
      +

      Deprecated. Use getAppKeywords method instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This property is deprecated. Please, use getAppKeywords method instead.")
+public var contextKeywords: [String] { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an application keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppKeyword(_ newElement: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElement + + +
      +

      The keyword to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      Adds multiple application keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElements + + +
      +

      A set of keywords to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeAppKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Removes an application keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppKeyword(_ element: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + element + + +
      +

      The keyword to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppKeywords() + +
      +
      +
      +
      +
      +
      +

      Clears all application keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getAppKeywords() + +
      +
      +
      +
      +
      +
      +

      Retrieves all application keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getAppKeywords() -> [String]
      + +
      +
      +
      +

      Return Value

      +

      An array of application keywords.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Internal Properties +

    +
    +
    +
      +
    • +
      + + + + parameterDictionary + +
      +
      +
      +
      +
      +
      +

      Dictionary of parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var parameterDictionary: [String : String]
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/Utils.html b/docs/Classes/Utils.html new file mode 100644 index 000000000..3e3635acc --- /dev/null +++ b/docs/Classes/Utils.html @@ -0,0 +1,450 @@ + + + + Utils Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Utils

    +
    +
    + + 
    public class Utils : NSObject
    + +
    +
    +

    A utility class for handling various ad-related operations and conversions.

    + +
    +
    +
    +
      +
    • +
      + + + + shared + +
      +
      +
      +
      +
      +
      +

      The class is created as a singleton object & used

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let shared: Utils
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + delegate + +
      +
      +
      +
      +
      +
      +

      A delegate to handle native ad events.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public weak var delegate: NativeAdDelegate?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Deprecated. MoPub is not available anymore. Use Prebid MAX adapters instead.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "MoPub is not available anymore. Use Prebid MAX adapters instead.")
+@objc
+public func convertDictToMoPubKeywords(dict: Dictionary<String, String>) -> String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + findNative(adObject:) + +
      +
      +
      +
      +
      +
      +

      Finds a native ad object within a given object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func findNative(adObject: AnyObject)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + adObject + + +
      +

      The object to search within.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/VideoAdUnit.html b/docs/Classes/VideoAdUnit.html new file mode 100644 index 000000000..241634dd9 --- /dev/null +++ b/docs/Classes/VideoAdUnit.html @@ -0,0 +1,450 @@ + + + + VideoAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    VideoAdUnit

    +
    +
    + + 
    @available(*, deprecated, message: "This class is deprecated. Please, use BannerAdUnit with video adFormat.")
+public class VideoAdUnit : AdUnit
    + +
    +
    +

    A deprecated class for handling video ad units.

    + +
    +
    +
    +
      +
    • +
      + + + + parameters + +
      +
      +
      +
      +
      +
      +

      The parameters for video ads associated with this ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var parameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:size:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of VideoAdUnit with the specified configuration ID and size.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String, size: CGSize)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + size + + +
      +

      The size of the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds additional sizes to the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAdditionalSize(sizes: [CGSize])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + sizes + + +
      +

      An array of CGSize objects representing the additional sizes for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/VideoControlsConfiguration.html b/docs/Classes/VideoControlsConfiguration.html new file mode 100644 index 000000000..2d3106de0 --- /dev/null +++ b/docs/Classes/VideoControlsConfiguration.html @@ -0,0 +1,572 @@ + + + + VideoControlsConfiguration Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    VideoControlsConfiguration

    +
    +
    + + 
    @objc(PBMVideoControlsConfiguration)
+@objcMembers
+public class VideoControlsConfiguration : NSObject
    + +
    +
    +

    A class representing the configuration for video controls in an ad. +This includes properties for video duration, mute status, and button positioning and visibility. +Configuration values can be initialized from bid response or set directly by the user.

    + +
    +
    +
    +
      +
    • +
      + + + + maxVideoDuration + +
      +
      +
      +
      +
      +
      +

      This property indicates maximum video duration. +Obtained from the field ext,prebid.passthrough[].adConfiguration.maxvideoduration.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      private(set) public var maxVideoDuration: NSNumber? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isMuted + +
      +
      +
      +
      +
      +
      +

      This property indicates whether the ad should run playback with sound or not. +Obtained from the field ext,prebid.passthrough[].adConfiguration.ismuted or set by user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var isMuted: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + closeButtonArea + +
      +
      +
      +
      +
      +
      +

      This property indicates the area which the close button should occupy on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.closebuttonarea or set by user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var closeButtonArea: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + closeButtonPosition + +
      +
      +
      +
      +
      +
      +

      This property indicates the position of the close button on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.closebuttonposition or set by user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var closeButtonPosition: Position { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipButtonArea + +
      +
      +
      +
      +
      +
      +

      This property indicates the area which the skip button should occupy on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.skipbuttonarea or set by user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var skipButtonArea: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipButtonPosition + +
      +
      +
      +
      +
      +
      +

      This property indicates the position of the skip button on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.skipbuttonposition or set by user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var skipButtonPosition: Position { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipDelay + +
      +
      +
      +
      +
      +
      +

      This property indicates the number of seconds which should be passed from the start of playback until the skip or close button should be shown. +Obtained from the field ext,prebid.passthrough[].adConfiguration.skipdelay or set by user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var skipDelay: Double
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isSoundButtonVisible + +
      +
      +
      +
      +
      +
      +

      This property indicates whether mute controls is visible on the screen.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var isSoundButtonVisible: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + initialize(with:) + +
      +
      +
      +
      +
      +
      +

      Use to initialize video controls with server values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func initialize(with ortbAdConfiguration: PBMORTBAdConfiguration?)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/VideoInterstitialAdUnit.html b/docs/Classes/VideoInterstitialAdUnit.html new file mode 100644 index 000000000..1c45d986e --- /dev/null +++ b/docs/Classes/VideoInterstitialAdUnit.html @@ -0,0 +1,466 @@ + + + + VideoInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    VideoInterstitialAdUnit

    +
    +
    + + 
    @available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")
+public class VideoInterstitialAdUnit : AdUnit
    + +
    +
    +

    A deprecated class representing a video interstitial ad unit. +This class is used to configure and manage video interstitial ads. It inherits from AdUnit and provides +specific settings for video ads including interstitial ad configuration and placement.

    + +
    +
    +
    +
      +
    • +
      + + + + parameters + +
      +
      +
      +
      +
      +
      +

      The video parameters for this ad unit. +This property allows you to get or set the video parameters for the ad unit’s configuration.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var parameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of VideoInterstitialAdUnit with the specified configuration ID. +The ad unit is configured as an interstitial ad with full screen placement and video parameters set for interstitial ads.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Convenience initializer to create a video interstitial ad unit with specified minimum width and height percentages.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configId: String, minWidthPerc: Int, minHeightPerc: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + minWidthPerc + + +
      +

      The minimum width percentage of the ad unit.

      +
      +
      + + minHeightPerc + + +
      +

      The minimum height percentage of the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/VideoParameters.html b/docs/Classes/VideoParameters.html new file mode 100644 index 000000000..eaf4dc9a2 --- /dev/null +++ b/docs/Classes/VideoParameters.html @@ -0,0 +1,814 @@ + + + + VideoParameters Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    VideoParameters

    +
    +
    + + 
    @objcMembers
+public class VideoParameters : NSObject
    + +
    +
    +

    Describes an OpenRTB video object

    + +
    +
    +
    +
      +
    • +
      + + + + api + +
      +
      +
      +
      +
      +
      +

      List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var api: [Signals.Api]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + maxBitrate + +
      +
      +
      +
      +
      +
      +

      Maximum bit rate in Kbps.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var maxBitrate: SingleContainerInt?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + minBitrate + +
      +
      +
      +
      +
      +
      +

      Maximum bit rate in Kbps.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var minBitrate: SingleContainerInt?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + maxDuration + +
      +
      +
      +
      +
      +
      +

      Maximum video ad duration in seconds.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var maxDuration: SingleContainerInt?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + minDuration + +
      +
      +
      +
      +
      +
      +

      Minimum video ad duration in seconds.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var minDuration: SingleContainerInt?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + mimes + +
      +
      +
      +
      +
      +
      +

      Content MIME types supported. +Prebid Server required property.

      +

      Example

      + +

      “video/mp4” +“video/x-ms-wmv”

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var mimes: [String]
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + playbackMethod + +
      +
      +
      +
      +
      +
      +

      Allowed playback methods. If none specified, assume all are allowed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var playbackMethod: [Signals.PlaybackMethod]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + protocols + +
      +
      +
      +
      +
      +
      +

      Array of supported video bid response protocols.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var protocols: [Signals.Protocols]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + startDelay + +
      +
      +
      +
      +
      +
      +

      Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var startDelay: Signals.StartDelay?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + placement + +
      +
      +
      +
      +
      +
      +

      Placement type for the impression.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var placement: Signals.Placement?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + linearity + +
      +
      +
      +
      +
      +
      +

      Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var linearity: SingleContainerInt?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adSize + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adSize: CGSize?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Helpers +

    +
    +
    +
      +
    • +
      + + + + rawAPI + +
      +
      +
      +
      +
      +
      +

      Helper property

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var rawAPI: [Int]? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + rawPlaybackMethod + +
      +
      +
      +
      +
      +
      +

      Helper property

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var rawPlaybackMethod: [Int]? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + rawProtocols + +
      +
      +
      +
      +
      +
      +

      Helper property

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var rawProtocols: [Int]? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(mimes:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(mimes: [String])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + mimes + + +
      +

      supported MIME types

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setSize(_:) + +
      +
      +
      +
      +
      +
      +

      Objective-C API

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setSize(_ size: NSValue)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums.html b/docs/Enums.html new file mode 100644 index 000000000..3c768acfd --- /dev/null +++ b/docs/Enums.html @@ -0,0 +1,603 @@ + + + + Enumerations Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Enumerations

    +

    The following enumerations are available globally.

    + +
    +
    +
    +
      +
    • +
      + + + + DataAsset + +
      +
      +
      +
      +
      +
      +

      Enum representing different types of native data assets.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public enum DataAsset : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeDataAssetType + +
      +
      +
      +
      +
      +
      +

      Enum representing various types of native data assets that can be used in ads.

      + +

      Each case represents a different type of data that can be provided in a native ad response. +Values are defined according to the type of data they represent, such as descriptive text, ratings, or pricing information.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public enum NativeDataAssetType : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeImageAssetType + +
      +
      +
      +
      +
      +
      +

      Enum representing various types of native image assets used in ads.

      + +

      Each case corresponds to a different type of image asset that can be used in native ads. +Values are defined according to the role or importance of the image in the ad.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public enum NativeImageAssetType : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Gender + +
      +
      +
      +
      +
      +
      +

      An enumeration representing gender options for ad targeting or other purposes. +This enum is used to specify different gender options and is intended for use in contexts where gender information may be relevant.

      + +
        +
      • unknown: Gender is not specified or unknown.
        • +
      • male: Represents the male gender.
        • +
      • female: Represents the female gender.
        • +
      • other: Represents any other gender that does not fit into the male or female categories.
        • +
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBMGender)
+public enum Gender : Int
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Enum representing the initialization status of the Prebid SDK.

      + +

      This enum provides various statuses that indicate the result of the Prebid SDK initialization process. It helps in understanding whether the SDK was successfully initialized or if there were issues during the initialization.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public enum PrebidInitializationStatus : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + PrebidHost + +
      +
      +
      +
      +
      +
      +

      PrebidHost represents various Prebid server hosts used for ad bidding.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public enum PrebidHost : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + AdPosition + +
      +
      +
      +
      +
      +
      +

      Ad position on screen. Refer to List 5.4: +The following table specifies the position of the ad as a relative measure of visibility or prominence. This +OpenRTB table has values derived from the Inventory Quality Guidelines (IQG). Practitioners should +keep in sync with updates to the IQG values as published on IAB.com. Values “4” - “7” apply to apps per +the mobile addendum to IQG version 2.1. +Value Description +0 Unknown +1 Above the Fold +2 DEPRECATED - May or may not be initially visible depending on screen size/resolution. +3 Below the Fold +4 Header +5 Footer +6 Sidebar +7 Full Screen

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBMAdPosition)
+public enum AdPosition : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Position + +
      +
      +
      +
      +
      +
      +

      Enum representing various positions on the screen.

      + +

      This enum defines positions that can be used for placing elements within an ad. The positions are typically used to determine where controls or components should be located within the ad’s user interface.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBMPosition)
+public enum Position : Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ResultCode + +
      +
      +
      +
      +
      +
      +

      Enum representing the result codes for various operations within the Prebid SDK.

      + +

      This enum provides a range of result codes indicating different outcomes or errors that may occur during SDK operations. Each case corresponds to a specific result or error, which helps in diagnosing issues and understanding the status of SDK operations.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public enum ResultCode : Int
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/AdPosition.html b/docs/Enums/AdPosition.html new file mode 100644 index 000000000..62c07eea8 --- /dev/null +++ b/docs/Enums/AdPosition.html @@ -0,0 +1,467 @@ + + + + AdPosition Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    AdPosition

    +
    +
    + + 
    @objc(PBMAdPosition)
+public enum AdPosition : Int
    + +
    +
    +

    Ad position on screen. Refer to List 5.4: +The following table specifies the position of the ad as a relative measure of visibility or prominence. This +OpenRTB table has values derived from the Inventory Quality Guidelines (IQG). Practitioners should +keep in sync with updates to the IQG values as published on IAB.com. Values “4” - “7” apply to apps per +the mobile addendum to IQG version 2.1. +Value Description +0 Unknown +1 Above the Fold +2 DEPRECATED - May or may not be initially visible depending on screen size/resolution. +3 Below the Fold +4 Header +5 Footer +6 Sidebar +7 Full Screen

    + +
    +
    +
    +
      +
    • +
      + + + + undefined + +
      +
      +
      +
      +
      +
      +

      0 Unknown

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case undefined = 0
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + header + +
      +
      +
      +
      +
      +
      +

      4 Header

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case header = 4
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + footer + +
      +
      +
      +
      +
      +
      +

      5 Footer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case footer = 5
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + sidebar + +
      +
      +
      +
      +
      +
      +

      6 Sidebar

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case sidebar = 6
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + fullScreen + +
      +
      +
      +
      +
      +
      +

      7 Full Screen

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case fullScreen = 7
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/DataAsset.html b/docs/Enums/DataAsset.html new file mode 100644 index 000000000..3be5bc0e0 --- /dev/null +++ b/docs/Enums/DataAsset.html @@ -0,0 +1,701 @@ + + + + DataAsset Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    DataAsset

    +
    +
    + + 
    @objc
+public enum DataAsset : Int
    + +
    +
    +

    Enum representing different types of native data assets.

    + +
    +
    +
    +
      +
    • +
      + + + + sponsored + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case sponsored = 1
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case description = 2
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + rating + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case rating = 3
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + likes + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case likes = 4
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + downloads + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case downloads = 5
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + price + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case price = 6
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + saleprice + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case saleprice = 7
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + phone + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case phone = 8
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + address + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case address = 9
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + description2 + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case description2 = 10
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + displayurl + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case displayurl = 11
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ctatext + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case ctatext = 12
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Custom type for user-defined data assets

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case Custom
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + exchangeID + +
      +
      +
      +
      +
      +
      +

      Gets or sets the exchange ID for the asset type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var exchangeID: Int { get set }
      + +
      +
      +
      +

      Return Value

      +

      The exchange ID for the asset type.

      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/Gender.html b/docs/Enums/Gender.html new file mode 100644 index 000000000..bf8605016 --- /dev/null +++ b/docs/Enums/Gender.html @@ -0,0 +1,435 @@ + + + + Gender Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Gender

    +
    +
    + + 
    @objc(PBMGender)
+public enum Gender : Int
    + +
    +
    +

    An enumeration representing gender options for ad targeting or other purposes. +This enum is used to specify different gender options and is intended for use in contexts where gender information may be relevant.

    + +
      +
    • unknown: Gender is not specified or unknown.
      • +
    • male: Represents the male gender.
      • +
    • female: Represents the female gender.
      • +
    • other: Represents any other gender that does not fit into the male or female categories.
      • +
    + +
    +
    +
    +
      +
    • +
      + + + + unknown + +
      +
      +
      +
      +
      +
      +

      Gender is not specified or unknown.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case unknown
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + male + +
      +
      +
      +
      +
      +
      +

      Represents the male gender.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case male
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + female + +
      +
      +
      +
      +
      +
      +

      Represents the female gender.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case female
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + other + +
      +
      +
      +
      +
      +
      +

      Represents any other gender that does not fit into the male or female categories.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case other
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/NativeDataAssetType.html b/docs/Enums/NativeDataAssetType.html new file mode 100644 index 000000000..c8e911c7e --- /dev/null +++ b/docs/Enums/NativeDataAssetType.html @@ -0,0 +1,700 @@ + + + + NativeDataAssetType Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeDataAssetType

    +
    +
    + + 
    @objc
+public enum NativeDataAssetType : Int
    + +
    +
    +

    Enum representing various types of native data assets that can be used in ads.

    + +

    Each case represents a different type of data that can be provided in a native ad response. +Values are defined according to the type of data they represent, such as descriptive text, ratings, or pricing information.

    + +
    +
    +
    +
      +
    • +
      + + + + undefined + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case undefined = 0
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + sponsored + +
      +
      +
      +
      +
      +
      +

      Sponsored By message where response should contain the brand name of the sponsor.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case sponsored = 1
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + desc + +
      +
      +
      +
      +
      +
      +

      Descriptive text associated with the product or service being advertised. Longer length of text in response may be truncated or ellipsed by the exchange.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case desc = 2
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + rating + +
      +
      +
      +
      +
      +
      +

      Rating of the product being offered to the user. For example an app’s rating in an app store from 0-5.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case rating = 3
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + likes + +
      +
      +
      +
      +
      +
      +

      Number of social ratings or “likes” of the product being offered to the user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case likes = 4
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + downloads + +
      +
      +
      +
      +
      +
      +

      Number downloads/installs of this product

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case downloads = 5
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + price + +
      +
      +
      +
      +
      +
      +

      Price for product / app / in-app purchase. Value should include currency symbol in localised format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case price = 6
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + salePrice + +
      +
      +
      +
      +
      +
      +

      Sale price that can be used together with price to indicate a discounted price compared to a regular price. Value should include currency symbol in localised format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case salePrice = 7
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + phone + +
      +
      +
      +
      +
      +
      +

      Phone number

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case phone = 8
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + address + +
      +
      +
      +
      +
      +
      +

      Address

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case address = 9
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + desc2 + +
      +
      +
      +
      +
      +
      +

      Additional descriptive text associated text with the product or service being advertised

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case desc2 = 10
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + displayURL + +
      +
      +
      +
      +
      +
      +

      Display URL for the text ad. To be used when sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in this field).

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case displayURL = 11
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ctaText + +
      +
      +
      +
      +
      +
      +

      CTA description - descriptive text describing a ‘call to action’ button for the destination URL.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case ctaText = 12
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + custom + +
      +
      +
      +
      +
      +
      +

      Reserved for Exchange specific usage numbered above 500

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case custom = 500
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/NativeImageAssetType.html b/docs/Enums/NativeImageAssetType.html new file mode 100644 index 000000000..4ea57b2c0 --- /dev/null +++ b/docs/Enums/NativeImageAssetType.html @@ -0,0 +1,403 @@ + + + + NativeImageAssetType Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeImageAssetType

    +
    +
    + + 
    @objc
+public enum NativeImageAssetType : Int
    + +
    +
    +

    Enum representing various types of native image assets used in ads.

    + +

    Each case corresponds to a different type of image asset that can be used in native ads. +Values are defined according to the role or importance of the image in the ad.

    + +
    +
    +
    +
      +
    • +
      + + + + icon + +
      +
      +
      +
      +
      +
      +

      Represents an icon image, which is typically a small image used as a visual representation of the product or service.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case icon = 1
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + main + +
      +
      +
      +
      +
      +
      +

      Represents the main image of the ad, which is usually the primary visual element and central to the ad’s presentation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case main = 3
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + custom + +
      +
      +
      +
      +
      +
      +

      Reserved for exchange-specific usage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case custom = 500
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/Position.html b/docs/Enums/Position.html new file mode 100644 index 000000000..14f111de7 --- /dev/null +++ b/docs/Enums/Position.html @@ -0,0 +1,614 @@ + + + + Position Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Position

    +
    +
    + + 
    @objc(PBMPosition)
+public enum Position : Int
    + +
    +
    +

    Enum representing various positions on the screen.

    + +

    This enum defines positions that can be used for placing elements within an ad. The positions are typically used to determine where controls or components should be located within the ad’s user interface.

    + +
    +
    +
    +
      +
    • +
      + + + + undefined + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case undefined = -1
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + topLeft + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case topLeft
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + topCenter + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case topCenter
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + topRight + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case topRight
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + center + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case center
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + bottomLeft + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case bottomLeft
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + bottomCenter + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case bottomCenter
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + bottomRight + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case bottomRight
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + custom + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case custom
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns the corresponding Position enum value for a given string literal.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static func getPositionByStringLiteral(_ stringValue: String) -> Position?
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + stringValue + + +
      +

      A string representing the position.

      +
      +
      +
      +
      +

      Return Value

      +

      The Position enum value if it matches one of the predefined cases; otherwise, returns nil.

      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/PrebidHost.html b/docs/Enums/PrebidHost.html new file mode 100644 index 000000000..eee1d26a0 --- /dev/null +++ b/docs/Enums/PrebidHost.html @@ -0,0 +1,400 @@ + + + + PrebidHost Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PrebidHost

    +
    +
    + + 
    @objc
+public enum PrebidHost : Int
    + +
    +
    +

    PrebidHost represents various Prebid server hosts used for ad bidding.

    + +
    +
    +
    + +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/PrebidInitializationStatus.html b/docs/Enums/PrebidInitializationStatus.html new file mode 100644 index 000000000..267f990dc --- /dev/null +++ b/docs/Enums/PrebidInitializationStatus.html @@ -0,0 +1,402 @@ + + + + PrebidInitializationStatus Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PrebidInitializationStatus

    +
    +
    + + 
    @objc
+public enum PrebidInitializationStatus : Int
    + +
    +
    +

    Enum representing the initialization status of the Prebid SDK.

    + +

    This enum provides various statuses that indicate the result of the Prebid SDK initialization process. It helps in understanding whether the SDK was successfully initialized or if there were issues during the initialization.

    + +
    +
    +
    +
      +
    • +
      + + + + succeeded + +
      +
      +
      +
      +
      +
      +

      Prebid SDK successfully initialized.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case succeeded
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + failed + +
      +
      +
      +
      +
      +
      +

      Prebid SDK is not able to work.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case failed
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + serverStatusWarning + +
      +
      +
      +
      +
      +
      +

      Something went wrong during PBS status checking.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case serverStatusWarning
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/ResultCode.html b/docs/Enums/ResultCode.html new file mode 100644 index 000000000..f95bb3288 --- /dev/null +++ b/docs/Enums/ResultCode.html @@ -0,0 +1,834 @@ + + + + ResultCode Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    ResultCode

    +
    +
    + + 
    @objc
+public enum ResultCode : Int
    + +
    +
    +

    Enum representing the result codes for various operations within the Prebid SDK.

    + +

    This enum provides a range of result codes indicating different outcomes or errors that may occur during SDK operations. Each case corresponds to a specific result or error, which helps in diagnosing issues and understanding the status of SDK operations.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      The demand fetch request was successful.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidDemandFetchSuccess = 0
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      The Prebid server was not specified in the request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidServerNotSpecified
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      The account ID provided is not recognized by the Prebid server.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidInvalidAccountId
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidInvalidConfigId + +
      +
      +
      +
      +
      +
      +

      The config ID provided is not recognized by the Prebid server.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidInvalidConfigId
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidInvalidSize + +
      +
      +
      +
      +
      +
      +

      The size requested is not recognized by the Prebid server.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidInvalidSize
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidNetworkError + +
      +
      +
      +
      +
      +
      +

      There was a network error during the operation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidNetworkError
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidServerError + +
      +
      +
      +
      +
      +
      +

      The Prebid server encountered an error while processing the request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidServerError
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidDemandNoBids + +
      +
      +
      +
      +
      +
      +

      The Prebid server did not return any bids.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidDemandNoBids
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidDemandTimedOut + +
      +
      +
      +
      +
      +
      +

      The demand request timed out.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidDemandTimedOut
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      The URL of the Prebid server is invalid.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidServerURLInvalid
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidUnknownError + +
      +
      +
      +
      +
      +
      +

      An unknown error occurred within the Prebid SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidUnknownError
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      The structure of the response received is invalid.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidInvalidResponseStructure = 1000
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      An internal error occurred within the SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidInternalSDKError = 7000
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidWrongArguments + +
      +
      +
      +
      +
      +
      +

      Incorrect arguments were provided to the SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidWrongArguments
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      No VAST tag was found in the media data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidNoVastTagInMediaData
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidSDKMisuse + +
      +
      +
      +
      +
      +
      +

      Misuse of the SDK was detected.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidSDKMisuse = 8000
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      SDK misuse due to a previous fetch operation not being completed yet.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidSDKMisusePreviousFetchNotCompletedYet
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + prebidInvalidRequest + +
      +
      +
      +
      +
      +
      +

      The Prebid request does not contain any parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case prebidInvalidRequest
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + name() + +
      +
      +
      +
      +
      +
      +

      Returns a descriptive name for the result code.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func name() -> String
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols.html b/docs/Protocols.html new file mode 100644 index 000000000..027aa6c27 --- /dev/null +++ b/docs/Protocols.html @@ -0,0 +1,552 @@ + + + + Protocols Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Protocols

    +

    The following protocols are available globally.

    + +
    +
    +
    +
      +
    • +
      + + + + NativeAdDelegate + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol NativeAdDelegate
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAdEventDelegate + +
      +
      +
      +
      +
      +
      +

      A protocol for handling events related to native ads.

      + +

      This protocol defines optional methods that can be implemented to handle various events associated with native ads, such as expiration, clicks, and impressions. Implementing this protocol allows for custom handling of these events within the native ad lifecycle.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol NativeAdEventDelegate
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + BannerEventHandler + +
      +
      +
      +
      +
      +
      +

      A protocol for handling events related to banner ads in the PBM SDK.

      + +

      This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol BannerEventHandler : PBMPrimaryAdRequesterProtocol
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + BannerViewDelegate + +
      +
      +
      +
      +
      +
      +

      A protocol for handling events related to banner ads in the PBM SDK.

      + +

      This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol BannerViewDelegate : NSObjectProtocol
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Protocol for interaction with the InterstitialAdUnit .

      + +

      All messages will be invoked on the main thread.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol InterstitialAdUnitDelegate : NSObjectProtocol
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Protocol for interaction with the RewardedAdUnit +All messages will be invoked on the main thread.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol RewardedAdUnitDelegate : NSObjectProtocol
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      A protocol for handling events related to rewarded ads.

      + +

      This protocol extends PBMInterstitialAd and defines properties for delegates that handle events related to the ad server communication and user interactions with rewarded ads. Implementing this protocol allows for custom handling of these events within the rewarded ad lifecycle.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol RewardedEventHandlerProtocol : PBMInterstitialAd
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This protocol is dedicated to manage the work with Mediation SDKs.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public protocol PrebidMediationDelegate
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/BannerEventHandler.html b/docs/Protocols/BannerEventHandler.html new file mode 100644 index 000000000..321f20106 --- /dev/null +++ b/docs/Protocols/BannerEventHandler.html @@ -0,0 +1,430 @@ + + + + BannerEventHandler Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BannerEventHandler

    +
    +
    + + 
    @objc
+public protocol BannerEventHandler : PBMPrimaryAdRequesterProtocol
    + +
    +
    +

    A protocol for handling events related to banner ads in the PBM SDK.

    + +

    This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

    + +
    +
    +
    +
      +
    • +
      + + + + loadingDelegate + +
      +
      +
      +
      +
      +
      +

      Delegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      weak var loadingDelegate: BannerEventLoadingDelegate? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + interactionDelegate + +
      +
      +
      +
      +
      +
      +

      Delegate for custom event handler to inform the PBM SDK about the events related to the user’s interaction with the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      weak var interactionDelegate: BannerEventInteractionDelegate? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adSizes + +
      +
      +
      +
      +
      +
      +

      The array of the CGRect entries for each valid ad sizes. +The first size is treated as a frame for related ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      var adSizes: [CGSize] { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + trackImpression() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func trackImpression()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/BannerViewDelegate.html b/docs/Protocols/BannerViewDelegate.html new file mode 100644 index 000000000..414eca8db --- /dev/null +++ b/docs/Protocols/BannerViewDelegate.html @@ -0,0 +1,581 @@ + + + + BannerViewDelegate Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BannerViewDelegate

    +
    +
    + + 
    @objc
+public protocol BannerViewDelegate : NSObjectProtocol
    + +
    +
    +

    A protocol for handling events related to banner ads in the PBM SDK.

    + +

    This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Asks the delegate for a view controller instance to use for presenting modal views +as a result of user interaction on an ad. Usual implementation may simply return self, +if it is view controller class.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func bannerViewPresentationController() -> UIViewController?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that an ad has been successfully loaded and rendered.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func bannerView(_ bannerView: BannerView, didReceiveAdWithAdSize adSize: CGSize)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + bannerView + + +
      +

      The BannerView instance sending the message.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate of an error encountered while loading or rendering an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func bannerView(_ bannerView: BannerView,
+                         didFailToReceiveAdWith error: Error)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + bannerView + + +
      +

      The BannerView instance sending the message.

      +
      +
      + + error + + +
      +

      The error encountered while attempting to receive or render the

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate whenever current app goes in the background due to user click.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func bannerViewWillLeaveApplication(_ bannerView: BannerView)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + bannerView + + +
      +

      The BannerView instance sending the message.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies delegate that the banner view will launch a modal +on top of the current view controller, as a result of user interaction.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func bannerViewWillPresentModal(_ bannerView: BannerView)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies delegate that the banner view has dismissed the modal on top of +the current view controller.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func bannerViewDidDismissModal(_ bannerView: BannerView)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + bannerView + + +
      +

      The BannerView instance sending the message.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/InterstitialAdUnitDelegate.html b/docs/Protocols/InterstitialAdUnitDelegate.html new file mode 100644 index 000000000..b2fbfc863 --- /dev/null +++ b/docs/Protocols/InterstitialAdUnitDelegate.html @@ -0,0 +1,490 @@ + + + + InterstitialAdUnitDelegate Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    InterstitialAdUnitDelegate

    +
    +
    + + 
    @objc
+public protocol InterstitialAdUnitDelegate : NSObjectProtocol
    + +
    +
    +

    Protocol for interaction with the InterstitialAdUnit .

    + +

    All messages will be invoked on the main thread.

    + +
    +
    +
    + +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/NativeAdDelegate.html b/docs/Protocols/NativeAdDelegate.html new file mode 100644 index 000000000..3d5bc5dfe --- /dev/null +++ b/docs/Protocols/NativeAdDelegate.html @@ -0,0 +1,402 @@ + + + + NativeAdDelegate Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAdDelegate

    +
    +
    + + 
    @objc
+public protocol NativeAdDelegate
    + +
    +
    +

    Undocumented

    + +
    +
    +
    +
      +
    • +
      + + + + nativeAdLoaded(ad:) + +
      +
      +
      +
      +
      +
      +

      A successful Prebid Native ad is returned

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func nativeAdLoaded(ad: NativeAd)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + nativeAdNotFound() + +
      +
      +
      +
      +
      +
      +

      Prebid Native was not found in the server returned response, +Please display the ad as regular ways

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func nativeAdNotFound()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + nativeAdNotValid() + +
      +
      +
      +
      +
      +
      +

      Prebid Native ad was returned, however, the bid is not valid for displaying +Should be treated as on ad load failed

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func nativeAdNotValid()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/NativeAdEventDelegate.html b/docs/Protocols/NativeAdEventDelegate.html new file mode 100644 index 000000000..324e29d61 --- /dev/null +++ b/docs/Protocols/NativeAdEventDelegate.html @@ -0,0 +1,405 @@ + + + + NativeAdEventDelegate Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAdEventDelegate

    +
    +
    + + 
    @objc
+public protocol NativeAdEventDelegate
    + +
    +
    +

    A protocol for handling events related to native ads.

    + +

    This protocol defines optional methods that can be implemented to handle various events associated with native ads, such as expiration, clicks, and impressions. Implementing this protocol allows for custom handling of these events within the native ad lifecycle.

    + +
    +
    +
    +
      +
    • +
      + + + + adDidExpire(ad:) + +
      +
      +
      +
      +
      +
      +

      Sent when the native ad is expired.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func adDidExpire(ad: NativeAd)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adWasClicked(ad:) + +
      +
      +
      +
      +
      +
      +

      Sent when the native view is clicked by the user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func adWasClicked(ad: NativeAd)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sent when an impression is recorded for an native ad

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func adDidLogImpression(ad: NativeAd)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/PrebidMediationDelegate.html b/docs/Protocols/PrebidMediationDelegate.html new file mode 100644 index 000000000..5f6660395 --- /dev/null +++ b/docs/Protocols/PrebidMediationDelegate.html @@ -0,0 +1,404 @@ + + + + PrebidMediationDelegate Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    PrebidMediationDelegate

    +
    +
    + + 
    @objc
+public protocol PrebidMediationDelegate
    + +
    +
    +

    This protocol is dedicated to manage the work with Mediation SDKs.

    + +
    +
    +
    +
      +
    • +
      + + + + setUpAdObject(with:) + +
      +
      +
      +
      +
      +
      +

      Puts to ad object’s localExtra the ad object (winning bid or native ad) and configId +and populates adObject’s keywords by targeting info +@return YES on success and NO otherwise (when the passed ad has wrong type)

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func setUpAdObject(with values: [String : Any]) -> Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + cleanUpAdObject() + +
      +
      +
      +
      +
      +
      +

      Removes an bid info from ad object’s localExtra +and prebid-specific keywords from ad object’s keywords

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func cleanUpAdObject()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getAdView() + +
      +
      +
      +
      +
      +
      +

      Returns ad view that was passed into PrebidMediationDelegate earlier. +Returns nil if there was no view passed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      func getAdView() -> UIView?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/RewardedAdUnitDelegate.html b/docs/Protocols/RewardedAdUnitDelegate.html new file mode 100644 index 000000000..feb243665 --- /dev/null +++ b/docs/Protocols/RewardedAdUnitDelegate.html @@ -0,0 +1,517 @@ + + + + RewardedAdUnitDelegate Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    RewardedAdUnitDelegate

    +
    +
    + + 
    @objc
+public protocol RewardedAdUnitDelegate : NSObjectProtocol
    + +
    +
    +

    Protocol for interaction with the RewardedAdUnit +All messages will be invoked on the main thread.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Called when an ad is loaded and ready for display

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAdDidReceiveAd(_ rewardedAd: RewardedAdUnit)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when user is able to receive a reward from the app

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAdUserDidEarnReward(_ rewardedAd: RewardedAdUnit)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the load process fails to produce a viable ad

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAd(_ rewardedAd: RewardedAdUnit,
+                         didFailToReceiveAdWithError error: Error?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the interstitial view will be launched, as a result of show() method.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAdWillPresentAd(_ rewardedAd: RewardedAdUnit)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the interstial is dismissed by the user

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAdDidDismissAd(_ rewardedAd: RewardedAdUnit)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when an ad causes the sdk to leave the app

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAdWillLeaveApplication(_ rewardedAd: RewardedAdUnit)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when user clicked the ad

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+optional func rewardedAdDidClickAd(_ rewardedAd: RewardedAdUnit)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Protocols/RewardedEventHandlerProtocol.html b/docs/Protocols/RewardedEventHandlerProtocol.html new file mode 100644 index 000000000..ad7b28853 --- /dev/null +++ b/docs/Protocols/RewardedEventHandlerProtocol.html @@ -0,0 +1,375 @@ + + + + RewardedEventHandlerProtocol Protocol Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    RewardedEventHandlerProtocol

    +
    +
    + + 
    @objc
+public protocol RewardedEventHandlerProtocol : PBMInterstitialAd
    + +
    +
    +

    A protocol for handling events related to rewarded ads.

    + +

    This protocol extends PBMInterstitialAd and defines properties for delegates that handle events related to the ad server communication and user interactions with rewarded ads. Implementing this protocol allows for custom handling of these events within the rewarded ad lifecycle.

    + +
    +
    +
    +
      +
    • +
      + + + + loadingDelegate + +
      +
      +
      +
      +
      +
      +

      Delegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      weak var loadingDelegate: RewardedEventLoadingDelegate? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + interactionDelegate + +
      +
      +
      +
      +
      +
      +

      Delegate for custom event handler to inform the PBM SDK about the events related to the user’s interaction with the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      weak var interactionDelegate: RewardedEventInteractionDelegate? { get set }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Typealiases.html b/docs/Typealiases.html new file mode 100644 index 000000000..be28a8e74 --- /dev/null +++ b/docs/Typealiases.html @@ -0,0 +1,369 @@ + + + + Type Aliases Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Type Aliases

    +

    The following type aliases are available globally.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      A callback used for Prebid initialization status.

      + +

      This callback is called when the Prebid SDK initialization completes. It provides the status of the initialization and any error that may have occurred.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public typealias PrebidInitializationCallback = ((PrebidInitializationStatus, Error?) -> Void)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + status + + +
      +

      The status of the Prebid initialization.

      +
      +
      + + error + + +
      +

      An optional error that occurred during initialization.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/badge.svg b/docs/badge.svg new file mode 100644 index 000000000..a5fd08ddc --- /dev/null +++ b/docs/badge.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + documentation + + + documentation + + + 94% + + + 94% + + + diff --git a/docs/css/highlight.css b/docs/css/highlight.css new file mode 100644 index 000000000..c170357ce --- /dev/null +++ b/docs/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css new file mode 100644 index 000000000..f84ef864f --- /dev/null +++ b/docs/css/jazzy.css @@ -0,0 +1,442 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { + background: transparent; + border: 0; + margin: 0; + outline: 0; + padding: 0; + vertical-align: baseline; } + +body { + background-color: #f2f2f2; + font-family: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + -webkit-font-smoothing: subpixel-antialiased; + word-wrap: break-word; } + +h1, h2, h3 { + margin-top: 0.8em; + margin-bottom: 0.3em; + font-weight: 100; + color: black; } + +h1 { + font-size: 2.5em; } + +h2 { + font-size: 2em; + border-bottom: 1px solid #e2e2e2; } + +h4 { + font-size: 13px; + line-height: 1.5; + margin-top: 21px; } + +h5 { + font-size: 1.1em; } + +h6 { + font-size: 1.1em; + color: #777; } + +.section-name { + color: gray; + display: block; + font-family: Helvetica; + font-size: 22px; + font-weight: 100; + margin-bottom: 15px; } + +pre, code { + font: 0.95em Menlo, monospace; + color: #777; + word-wrap: normal; } + +p code, li code { + background-color: #eee; + padding: 2px 4px; + border-radius: 4px; } + +pre > code { + padding: 0; } + +a { + color: #0088cc; + text-decoration: none; } + a code { + color: inherit; } + +ul { + padding-left: 15px; } + +li { + line-height: 1.8em; } + +img { + max-width: 100%; } + +blockquote { + margin-left: 0; + padding: 0 10px; + border-left: 4px solid #ccc; } + +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + +.content-wrapper { + margin: 0 auto; + width: 980px; } + +header { + font-size: 0.85em; + line-height: 32px; + background-color: #414141; + position: fixed; + width: 100%; + z-index: 3; } + header img { + padding-right: 6px; + vertical-align: -3px; + height: 16px; } + header a { + color: #fff; } + header p { + float: left; + color: #999; } + header .header-right { + float: right; + margin-left: 16px; } + +#breadcrumbs { + background-color: #f2f2f2; + height: 26px; + padding-top: 12px; + position: fixed; + width: inherit; + z-index: 2; + margin-top: 32px; + white-space: nowrap; + overflow-x: scroll; } + #breadcrumbs #carat { + height: 10px; + margin: 0 5px; } + +.sidebar { + background-color: #f9f9f9; + border: 1px solid #e2e2e2; + overflow-y: auto; + overflow-x: hidden; + position: fixed; + top: 70px; + bottom: 0; + width: 230px; + word-wrap: normal; } + +.nav-groups { + list-style-type: none; + background: #fff; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #e2e2e2; + font-size: 1.1em; + font-weight: 100; + padding: 15px 0 15px 20px; } + .nav-group-name > a { + color: #333; } + +.nav-group-tasks { + margin-top: 5px; } + +.nav-group-task { + font-size: 0.9em; + list-style-type: none; + white-space: nowrap; } + .nav-group-task a { + color: #888; } + +.main-content { + background-color: #fff; + border: 1px solid #e2e2e2; + margin-left: 246px; + position: absolute; + overflow: hidden; + padding-bottom: 20px; + top: 70px; + width: 734px; } + .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote { + margin-bottom: 1em; } + .main-content p { + line-height: 1.8em; } + .main-content section .section:first-child { + margin-top: 0; + padding-top: 0; } + .main-content section .task-group-section .task-group:first-of-type { + padding-top: 10px; } + .main-content section .task-group-section .task-group:first-of-type .section-name { + padding-top: 15px; } + .main-content section .heading:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .main-content .section-name p { + margin-bottom: inherit; + line-height: inherit; } + .main-content .section-name code { + background-color: inherit; + padding: inherit; + color: inherit; } + +.section { + padding: 0 25px; } + +.highlight { + background-color: #eee; + padding: 10px 12px; + border: 1px solid #e2e2e2; + border-radius: 4px; + overflow-x: auto; } + +.declaration .highlight { + overflow-x: initial; + padding: 0 40px 40px 0; + margin-bottom: -25px; + background-color: transparent; + border: none; } + +.section-name { + margin: 0; + margin-left: 18px; } + +.task-group-section { + margin-top: 10px; + padding-left: 6px; + border-top: 1px solid #e2e2e2; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + +.section-name-container { + position: relative; + display: inline-block; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .item code { + background-color: transparent; + padding: 0; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 35px; + font-size: 11.9px; + transition: all 300ms; } + .item .token-open { + margin-left: 20px; } + .item .discouraged { + text-decoration: line-through; } + +.declaration-note { + font-size: .85em; + color: gray; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #e2e2e2; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + background: #f9f9f9; + border-left: 1px solid #e2e2e2; + border-top: 1px solid #e2e2e2; + height: 12px; + left: 21px; + top: -7px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + position: absolute; + width: 12px; } + +.height-container { + display: none; + left: -25px; + padding: 0 25px; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #f9f9f9; + border-bottom: 1px solid #e2e2e2; + left: -25px; + position: relative; + width: 100%; + padding-top: 10px; + padding-bottom: 5px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4b8afb; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #e2e2e2; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +#footer { + position: relative; + top: 10px; + bottom: 0px; + margin-left: 25px; } + #footer p { + margin: 0; + color: #aaa; + font-size: 0.8em; } + +html.dash header, html.dash #breadcrumbs, html.dash .sidebar { + display: none; } + +html.dash .main-content { + width: 980px; + margin-left: 0; + border: none; + width: 100%; + top: 0; + padding-bottom: 0; } + +html.dash .height-container { + display: block; } + +html.dash .item .token { + margin-left: 0; } + +html.dash .content-wrapper { + width: auto; } + +html.dash #footer { + position: static; } + +form[role=search] { + float: right; } + form[role=search] input { + font: Helvetica, freesans, Arial, sans-serif; + margin-top: 6px; + font-size: 13px; + line-height: 20px; + padding: 0px 10px; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fff; + color: #333; + border: 1px solid #e2e2e2; + z-index: 4; } + form[role=search] .tt-highlight { + font-weight: bold; } + form[role=search] .tt-suggestion { + font: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + form[role=search] .tt-suggestion:hover, + form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + form[role=search] .tt-suggestion:hover .doc-parent-name, + form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docs/docsets/PrebidMobile.docset/Contents/Info.plist b/docs/docsets/PrebidMobile.docset/Contents/Info.plist new file mode 100644 index 000000000..d6e95a1e5 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Info.plist @@ -0,0 +1,20 @@ + + + + + CFBundleIdentifier + com.jazzy.prebidmobile + CFBundleName + PrebidMobile + DocSetPlatformFamily + prebidmobile + isDashDocset + + dashIndexFilePath + index.html + isJavaScriptEnabled + + DashDocSetFamily + dashtoc + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes.html new file mode 100644 index 000000000..a27deddfd --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes.html @@ -0,0 +1,1865 @@ + + + + Classes Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Classes

    +

    The following classes are available globally.

    + +
    +
    +
    +
      +
    • +
      + + + + AdUnit + +
      +
      +
      +
      +
      +
      +

      Base class for ad units built for original type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class AdUnit : NSObject, DispatcherDelegate
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + BannerAdUnit + +
      +
      +
      +
      +
      +
      +

      A class representing a banner ad unit for original type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class BannerAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + InstreamVideoAdUnit + +
      +
      +
      +
      +
      +
      +

      Represents an instream video ad unit for original type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + InterstitialAdUnit + +
      +
      +
      +
      +
      +
      +

      Represents an interstitial ad unit built for original type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + BidInfo + +
      +
      +
      +
      +
      +
      +

      Contains information about bid.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+@objc(PBMBidInfo)
+public class BidInfo : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + PrebidAdUnit + +
      +
      +
      +
      +
      +
      +

      Multiformat ad unit. Built for original API.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class PrebidAdUnit : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + PrebidRequest + +
      +
      +
      +
      +
      +
      +

      Class that contains properties and methods to configure Prebid request.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class PrebidRequest : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ContextSubType + +
      +
      +
      +
      +
      +
      +

      Native context subtype asset.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class ContextSubType : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ContextType + +
      +
      +
      +
      +
      +
      +

      Native context type asset.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class ContextType : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAd + +
      +
      +
      +
      +
      +
      +

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

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeAd : NSObject, CacheExpiryDelegate
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAdConfiguration + +
      +
      +
      +
      +
      +
      +

      Represents the configuration for a native ad, including markup and version information.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBMNativeAdConfiguration)
+@objcMembers
+public class NativeAdConfiguration : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAdMarkup + +
      +
      +
      +
      +
      +
      +

      Represents the markup for a native ad, including assets, tracking URLs, and other metadata.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeAdMarkup : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAdMarkupAsset + +
      +
      +
      +
      +
      +
      +

      Represents an asset in the native ad markup, which can be a title, image, data, or link.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeAdMarkupAsset : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAsset + +
      +
      +
      +
      +
      +
      +

      Represents a generic native ad asset which could be a title, image, or data.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class NativeAsset : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAssetTitle + +
      +
      +
      +
      +
      +
      +

      Represents a title asset in a native ad.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeAssetTitle : NativeAsset
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAssetImage + +
      +
      +
      +
      +
      +
      +

      Represents an image asset in a native ad.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeAssetImage : NativeAsset
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeAssetData + +
      +
      +
      +
      +
      +
      +

      Represents a data asset in a native ad.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeAssetData : NativeAsset
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ImageAsset + +
      +
      +
      +
      +
      +
      +

      Native image asset type.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class ImageAsset : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeData + +
      +
      +
      +
      +
      +
      +

      Class representing native data elements in the ad markup.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeData : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeEventTracker + +
      +
      +
      +
      +
      +
      +

      Class representing an event tracker for native ads.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public class NativeEventTracker : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + EventType + +
      +
      +
      +
      +
      +
      +

      Class representing different event types.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class EventType : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + EventTracking + +
      +
      +
      +
      +
      +
      +

      Native event tracking type.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class EventTracking : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Class representing a response for a native event tracker.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeEventTrackerResponse : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeImage + +
      +
      +
      +
      +
      +
      +

      Class representing an image asset in a native ad.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeImage : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeLink + +
      +
      +
      +
      +
      +
      +

      Class representing a link in a native ad.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeLink : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Represents a request object for native markup, including details about the ad’s context, placement, and supported features.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBMNativeMarkupRequestObject)
+@objcMembers
+public class NativeMarkupRequestObject : NSObject, NSCopying, PBMJsonCodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeRequest + +
      +
      +
      +
      +
      +
      +

      A class representing a native request for original type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class NativeRequest : AdUnit
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeTitle + +
      +
      +
      +
      +
      +
      +

      Represents the title element in a native ad, including optional text and length.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeTitle : NSObject, JsonDecodable
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + PlacementType + +
      +
      +
      +
      +
      +
      +

      Represents different types of placements for native ads.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class PlacementType : SingleContainerInt
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + BannerParameters + +
      +
      +
      +
      +
      +
      +

      Describes an OpenRTB banner object

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class BannerParameters : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + NativeParameters + +
      +
      +
      +
      +
      +
      +

      Represents parameters for a native ad request, including assets, event trackers, and configuration settings.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class NativeParameters : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Signals + +
      +
      +
      +
      +
      +
      +

      A class containing constants related to OpenRTB signals.

      + +

      This class provides static constants and values representing different +API frameworks, playback methods, protocols, start delays, and video +placement types as defined in the OpenRTB specification.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class Signals : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + SingleContainerInt + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class SingleContainerInt : NSObject, ExpressibleByIntegerLiteral
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VideoParameters + +
      +
      +
      +
      +
      +
      +

      Describes an OpenRTB video object

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class VideoParameters : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + RewardedVideoAdUnit + +
      +
      +
      +
      +
      +
      +

      Represents an rewarded ad unit for original type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Utils + +
      +
      +
      +
      +
      +
      +

      A utility class for handling various ad-related operations and conversions.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class Utils : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + VideoAdUnit + +
      +
      +
      +
      +
      +
      +

      A deprecated class for handling video ad units.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This class is deprecated. Please, use BannerAdUnit with video adFormat.")
+public class VideoAdUnit : AdUnit
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      A deprecated class representing a video interstitial ad unit. +This class is used to configure and manage video interstitial ads. It inherits from AdUnit and provides +specific settings for video ads including interstitial ad configuration and placement.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")
+public class VideoInterstitialAdUnit : AdUnit
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Prebid + +
      +
      +
      +
      +
      +
      +

      The Prebid class manages the configuration and initialization of the PrebidMobile SDK.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class Prebid : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Targeting + +
      +
      +
      +
      +
      +
      +

      A class that manages targeting information for ads.

      + +

      This class provides properties and methods for setting and retrieving +user-specific targeting information, such as user ID, gender, and custom +data. It also includes details for OMID (Open Measurement Interface Definition) +partner and supports managing user identity links and custom extensions.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class Targeting : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ExternalUserId + +
      +
      +
      +
      +
      +
      +

      Defines the User Id Object from an External Thrid Party Source

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class ExternalUserId : NSObject, NSCoding, NSSecureCoding, JSONConvertible
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Host + +
      +
      +
      +
      +
      +
      +

      A singleton class that manages the Prebid server URL, including a custom URL.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class Host : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + AdFormat + +
      +
      +
      +
      +
      +
      +

      AdFormat is a class that represents different types of ad formats using an OptionSet. +The class also includes a deprecated display format for backward compatibility, marked with a deprecation message.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class AdFormat : NSObject, OptionSet
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      A class representing the configuration for video controls in an ad. +This includes properties for video duration, mute status, and button positioning and visibility. +Configuration values can be initialized from bid response or set directly by the user.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc(PBMVideoControlsConfiguration)
+@objcMembers
+public class VideoControlsConfiguration : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + BannerView + +
      +
      +
      +
      +
      +
      +

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

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class BannerView: UIView,
+                         BannerAdLoaderDelegate,
+                         AdLoadFlowControllerDelegate,
+                         BannerEventInteractionDelegate,
+                         DisplayViewInteractionDelegate
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      A base class for interstitial ad units.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class BaseInterstitialAdUnit :
+    NSObject,
+    PBMInterstitialAdLoaderDelegate,
+    AdLoadFlowControllerDelegate,
+    InterstitialControllerInteractionDelegate,
+    InterstitialEventInteractionDelegate,
+    BaseInterstitialAdUnitProtocol
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Represents an interstitial ad unit. Built for rendering type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class InterstitialRenderingAdUnit : BaseInterstitialAdUnit
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + RewardedAdUnit + +
      +
      +
      +
      +
      +
      +

      Represents an rewarded ad unit. Built for rendering type of integration.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public class RewardedAdUnit: BaseInterstitialAdUnit,
+                             RewardedEventInteractionDelegate
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + MediationBannerAdUnit + +
      +
      +
      +
      +
      +
      +

      This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class MediationBannerAdUnit : NSObject
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Base class for interstitial ads in Mediation API.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class MediationBaseInterstitialAdUnit : NSObject
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class MediationInterstitialAdUnit : MediationBaseInterstitialAdUnit
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + MediationNativeAdUnit + +
      +
      +
      +
      +
      +
      +

      This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class MediationNativeAdUnit : NSObject
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objcMembers
+public class MediationRewardedAdUnit : MediationBaseInterstitialAdUnit
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/AdFormat.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/AdFormat.html new file mode 100644 index 000000000..29ef7ef79 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/AdFormat.html @@ -0,0 +1,641 @@ + + + + AdFormat Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    AdFormat

    +
    +
    + + 
    @objcMembers
+public class AdFormat : NSObject, OptionSet
    + +
    +
    +

    AdFormat is a class that represents different types of ad formats using an OptionSet. +The class also includes a deprecated display format for backward compatibility, marked with a deprecation message.

    + +
    +
    +
    +
      +
    • +
      + + + + RawValue + +
      +
      +
      +
      +
      +
      +

      The underlying type of the raw value.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public typealias RawValue = Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + rawValue + +
      +
      +
      +
      +
      +
      +

      The raw integer value representing the ad format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public let rawValue: Int
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + stringEquivalent + +
      +
      +
      +
      +
      +
      +

      The string representation of the ad format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var stringEquivalent: String? { get }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes an AdFormat instance with a specified raw value and its string equivalent.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(rawValue: RawValue, stringEquivalent: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + rawValue + + +
      +

      The raw value representing the ad format.

      +
      +
      + + stringEquivalent + + +
      +

      A string equivalent of the ad format.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init(rawValue:) + +
      +
      +
      +
      +
      +
      +

      Initializes an AdFormat instance with a specified raw value.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init(rawValue: RawValue)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + rawValue + + +
      +

      The raw value representing the ad format.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + banner + +
      +
      +
      +
      +
      +
      +

      Represents a banner ad format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let banner: AdFormat
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + video + +
      +
      +
      +
      +
      +
      +

      Represents a video ad format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let video: AdFormat
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + native + +
      +
      +
      +
      +
      +
      +

      Represents a native ad format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let native: AdFormat
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + display + +
      +
      +
      +
      +
      +
      +

      Represents a deprecated display ad format.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "Display ad format is deprecated. Please, use banner ad format instead.")
+public static let display: AdFormat
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + allCases + +
      +
      +
      +
      +
      +
      +

      An array containing all cases of ad formats, excluding deprecated ones.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static var allCases: [AdFormat] { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/AdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/AdUnit.html new file mode 100644 index 000000000..3f452f4b2 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/AdUnit.html @@ -0,0 +1,1738 @@ + + + + AdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    AdUnit

    +
    +
    + + 
    @objcMembers
+public class AdUnit : NSObject, DispatcherDelegate
    + +
    +
    +

    Base class for ad units built for original type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + pbAdSlot + +
      +
      +
      +
      +
      +
      +

      ORTB: imp[].ext.data.adslot

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var pbAdSlot: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new AdUnit instance with the specified configuration ID, size, and ad formats.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String, size: CGSize?, adFormats: Set<AdFormat>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + size + + +
      +

      The primary size of the ad. If nil, a default size of .zero is used.

      +
      +
      + + adFormats + + +
      +

      A set of ad formats supported by the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request and provides the result as a dictionary of key-value pairs.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "Deprecated. Use fetchDemand(completion: @escaping (_ bidInfo: BidInfo﹚ -> Void﹚ instead.")
+dynamic public func fetchDemand(completion: @escaping (_ result: ResultCode, _ kvResultDict: [String : String]?) -> Void)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      A closure called with the result code and an optional dictionary of targeting keywords. + +

        +
      • result: The result code indicating the outcome of the demand fetch.
        • +
      • kvResultDict: A dictionary containing key-value pairs, or nil if no demand was fetched.
        • +

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request and provides the result as a BidInfo object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      dynamic public func fetchDemand(completionBidInfo: @escaping (_ bidInfo: BidInfo) -> Void)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completionBidInfo + + +
      +

      A closure called with a BidInfo object representing the fetched demand.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request for a specific ad object and provides the result code. Setups targeting keywords into the adObject.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      dynamic public func fetchDemand(adObject: AnyObject, completion: @escaping (_ result: ResultCode) -> Void)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + adObject + + +
      +

      The ad object for which demand is being fetched.

      +
      +
      + + completion + + +
      +

      A closure called with the result code indicating the outcome of the demand fetch.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    adunit ext data aka inventory data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & value for adunit context targeting +If the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & values for adunit context targeting +The values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context data keyword & values set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all context data set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & values for adunit targeting +The values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific ext data keyword & values set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all ext data set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    adunit ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context keyword from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method allows to remove specific keyword from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content object, replacing any existing content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAppContent(_ appContentObject: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContentObject + + +
      +

      The PBMORTBAppContent object representing the app’s content.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + getAppContent() + +
      +
      +
      +
      +
      +
      +

      Retrieves the current app content object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getAppContent() -> PBMORTBAppContent?
      + +
      +
      +
      +

      Return Value

      +

      The current PBMORTBAppContent object, or nil if no content is set.

      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the current app content object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of content data objects to the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      An array of PBMORTBContentData objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a specific content data object from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppContentData(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The PBMORTBContentData object to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContentData() + +
      +
      +
      +
      +
      +
      +

      Clears all content data objects from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContentData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + getUserData() + +
      +
      +
      +
      +
      +
      +

      Retrieves the current user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getUserData() -> [PBMORTBContentData]?
      + +
      +
      +
      +

      Return Value

      +

      An array of PBMORTBContentData objects representing the user data, or nil if no data is available.

      +
      +
      +
      +
      • +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      An array of PBMORTBContentData objects to add to the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a specific user data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The PBMORTBContentData object to remove from the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    GPID +

    +
    +
    +
      +
    • +
      + + + + setGPID(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the GPID for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setGPID(_ gpid: String?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + gpid + + +
      +

      The GPID string to set. Can be nil to clear the GPID.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + getGPID() + +
      +
      +
      +
      +
      +
      +

      Retrieves the current GPID for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getGPID() -> String?
      + +
      +
      +
      +

      Return Value

      +

      The GPID string, or nil if no GPID is set.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Global ORTBObject +

    +
    +
    +
      +
    • +
      + + + + setOrtbConfig(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the OpenRTB configuration string for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setOrtbConfig(_ ortbObject: String?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + ortbObject + + +
      +

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

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + getOrtbConfig() + +
      +
      +
      +
      +
      +
      +

      Retrieves the current OpenRTB configuration string for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getOrtbConfig() -> String?
      + +
      +
      +
      +

      Return Value

      +

      The OpenRTB configuration string, or nil if no configuration is set.

      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    others +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method allows to set the auto refresh period for the demand

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAutoRefreshMillis(time: Double)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + time + + +
      +

      refresh time interval

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + stopAutoRefresh() + +
      +
      +
      +
      +
      +
      +

      This method stops the auto refresh of demand

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func stopAutoRefresh()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + resumeAutoRefresh() + +
      +
      +
      +
      +
      +
      +

      This method resumes the auto refresh of demand

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func resumeAutoRefresh()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerAdUnit.html new file mode 100644 index 000000000..a7a2b7058 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerAdUnit.html @@ -0,0 +1,531 @@ + + + + BannerAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BannerAdUnit

    +
    +
    + + 
    public class BannerAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
    + +
    +
    +

    A class representing a banner ad unit for original type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + parameters + +
      +
      +
      +
      +
      +
      +

      A deprecated property for banner ad parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This property is deprecated. Please, use bannerParameters instead.")
+public var parameters: BannerParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + bannerParameters + +
      +
      +
      +
      +
      +
      +

      The banner ad parameters used to configure the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var bannerParameters: BannerParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      The video ad parameters used to configure the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var videoParameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adFormats + +
      +
      +
      +
      +
      +
      +

      The set of ad formats for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adFormats: Set<AdFormat> { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:size:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new BannerAdUnit with the specified configuration ID and size.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String, size: CGSize)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configId + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + size + + +
      +

      The size of the banner ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds additional sizes to the banner ad unit’s configuration.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAdditionalSize(sizes: [CGSize])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + sizes + + +
      +

      An array of CGSize objects representing additional sizes.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerParameters.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerParameters.html new file mode 100644 index 000000000..929583369 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerParameters.html @@ -0,0 +1,467 @@ + + + + BannerParameters Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BannerParameters

    +
    +
    + + 
    @objcMembers
+public class BannerParameters : NSObject
    + +
    +
    +

    Describes an OpenRTB banner object

    + +
    +
    +
    +
      +
    • +
      + + + + api + +
      +
      +
      +
      +
      +
      +

      List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var api: [Signals.Api]?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Min width percentage value for interstitial

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var interstitialMinWidthPerc: Int?
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Min height percentage value for interstitial

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var interstitialMinHeightPerc: Int?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adSizes + +
      +
      +
      +
      +
      +
      +

      Ad sizes of the ad

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adSizes: [CGSize]?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Helpers +

    +
    +
    +
      +
    • +
      + + + + rawAPI + +
      +
      +
      +
      +
      +
      +

      Helper for api values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var rawAPI: [Int]? { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerView.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerView.html new file mode 100644 index 000000000..f1faa7e1f --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BannerView.html @@ -0,0 +1,2564 @@ + + + + BannerView Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BannerView

    +
    +
    + + 
    public class BannerView: UIView,
+                         BannerAdLoaderDelegate,
+                         AdLoadFlowControllerDelegate,
+                         BannerEventInteractionDelegate,
+                         DisplayViewInteractionDelegate
    + +
    +
    +

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

    + +
    +
    +
    +
      +
    • +
      + + + + adUnitConfig + +
      +
      +
      +
      +
      +
      +

      The ad unit configuration.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public let adUnitConfig: AdUnitConfig
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + eventHandler + +
      +
      +
      +
      +
      +
      +

      The event handler for banner view events.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public let eventHandler: BannerEventHandler?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Properties +

    +
    +
    +
      +
    • +
      + + + + bannerParameters + +
      +
      +
      +
      +
      +
      +

      Banner-specific parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var bannerParameters: BannerParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      Video-specific parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var videoParameters: VideoParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + lastBidResponse + +
      +
      +
      +
      +
      +
      +

      The last bid response received.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var lastBidResponse: BidResponse? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + configID + +
      +
      +
      +
      +
      +
      +

      ID of Stored Impression on the Prebid server

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var configID: String { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + refreshInterval + +
      +
      +
      +
      +
      +
      +

      The interval for refreshing the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var refreshInterval: TimeInterval { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + additionalSizes + +
      +
      +
      +
      +
      +
      +

      Additional sizes for the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var additionalSizes: [CGSize]? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adFormat + +
      +
      +
      +
      +
      +
      +

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

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var adFormat: AdFormat { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adPosition + +
      +
      +
      +
      +
      +
      +

      The position of the ad on the screen.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var adPosition: AdPosition { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ortbConfig + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var ortbConfig: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + delegate + +
      +
      +
      +
      +
      +
      +

      ORTB configuration string.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public weak var delegate: BannerViewDelegate?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a new BannerView.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+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.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

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

      + +
      +
      +

      Declaration

      +
      +

      Swift

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

      Parameters

      + + + + + + + + + + + +
      + + configID + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + eventHandler + + +
      +

      The event handler for the banner view.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

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

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+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

      + 
      @objc
+public func loadAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the stored auction response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func setStoredAuctionResponse(storedAuction: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + storedAuction + + +
      +

      The stored auction response string.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + stopRefresh() + +
      +
      +
      +
      +
      +
      +

      Stops the auto-refresh of the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func stopRefresh()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext Data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Adds context data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+@objc
+public func addContextData(_ data: String, forKey key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + data + + +
      +

      The data to add.

      +
      +
      + + key + + +
      +

      The key associated with the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Updates context data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+@objc
+public func updateContextData(_ data: Set<String>, forKey key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + data + + +
      +

      A set of data to update.

      +
      +
      + + key + + +
      +

      The key associated with the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes context data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+@objc
+public func removeContextDate(forKey key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + key + + +
      +

      The key associated with the data to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      Clears all context data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+@objc
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addExtData(key: String, value: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the data.

      +
      +
      + + value + + +
      +

      The value for the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Updates ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the data.

      +
      +
      + + value + + +
      +

      The value for the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeExtData(forKey: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + key + + +
      +

      The key for the data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      Clears ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Adds a context keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+@objc
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElement + + +
      +

      The keyword to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds a set of context keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+@objc
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElements + + +
      +

      A set of keywords to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a context keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+@objc
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + element + + +
      +

      The keyword to remove.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all context keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+@objc
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an extended keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElement + + +
      +

      The keyword to be added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      Adds multiple extended keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElements + + +
      +

      A set of keywords to be added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Removes an extended keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + element + + +
      +

      The keyword to be removed.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      Clears all extended keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func setAppContent(_ appContent: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContent + + +
      +

      The app content data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the app content data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds app content data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      The data objects to be added.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes an app content data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeAppContentDataObject(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The data object to be removed.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all app content data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearAppContentDataObjects()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      The user data objects to be added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a user data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The user data object to be removed.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    DisplayViewInteractionDelegate +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func trackImpression(forDisplayView: PBMDisplayView)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func viewControllerForModalPresentation(fromDisplayView: PBMDisplayView) -> UIViewController?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + didLeaveApp(from:) + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func didLeaveApp(from displayView: PBMDisplayView)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func willPresentModal(from displayView: PBMDisplayView)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func didDismissModal(from displayView: PBMDisplayView)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    BannerAdLoaderDelegate +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func bannerAdLoader(_ bannerAdLoader: PBMBannerAdLoader, loadedAdView adView: UIView, adSize: CGSize)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func bannerAdLoader(_ bannerAdLoader: PBMBannerAdLoader, createdDisplayView displayView: PBMDisplayView)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    PBMAdLoadFlowControllerDelegate +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowController(_ adLoadFlowController: PBMAdLoadFlowController, failedWithError error: Error?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowControllerWillSendBidRequest(_ adLoadFlowController: PBMAdLoadFlowController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowControllerWillRequestPrimaryAd(_ adLoadFlowController: PBMAdLoadFlowController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowControllerShouldContinue(_ adLoadFlowController: PBMAdLoadFlowController) -> Bool
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    BannerEventInteractionDelegate +

    +
    +
    +
      +
    • +
      + + + + willPresentModal() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func willPresentModal()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + didDismissModal() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func didDismissModal()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + willLeaveApp() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func willLeaveApp()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var viewControllerForPresentingModal: UIViewController? { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BaseInterstitialAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BaseInterstitialAdUnit.html new file mode 100644 index 000000000..89f5b02d2 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BaseInterstitialAdUnit.html @@ -0,0 +1,3118 @@ + + + + BaseInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BaseInterstitialAdUnit

    +
    +
    + + 
    public class BaseInterstitialAdUnit :
+    NSObject,
+    PBMInterstitialAdLoaderDelegate,
+    AdLoadFlowControllerDelegate,
+    InterstitialControllerInteractionDelegate,
+    InterstitialEventInteractionDelegate,
+    BaseInterstitialAdUnitProtocol
    + +
    +
    +

    A base class for interstitial ad units.

    + +
    +
    +
    +
    + + +
    + +

    Public Properties +

    +
    +
    +
      +
    • +
      + + + + bannerParameters + +
      +
      +
      +
      +
      +
      +

      The banner parameters used for configuring ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var bannerParameters: BannerParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      The video parameters used for configuring ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var videoParameters: VideoParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + lastBidResponse + +
      +
      +
      +
      +
      +
      +

      The last bid response received for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var lastBidResponse: BidResponse? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + configID + +
      +
      +
      +
      +
      +
      +

      The configuration ID for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var configID: String { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adFormats + +
      +
      +
      +
      +
      +
      +

      The set of ad formats supported by this ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var adFormats: Set<AdFormat> { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ortbConfig + +
      +
      +
      +
      +
      +
      +

      The ORTB (OpenRTB) configuration string for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var ortbConfig: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isReady + +
      +
      +
      +
      +
      +
      +

      A Boolean value indicating whether the ad unit is ready to be displayed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var isReady: Bool { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isMuted + +
      +
      +
      +
      +
      +
      +

      A Boolean value indicating whether the video controls are muted.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var isMuted: Bool { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isSoundButtonVisible + +
      +
      +
      +
      +
      +
      +

      A Boolean value indicating whether the sound button is visible in the video controls.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var isSoundButtonVisible: Bool { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + closeButtonArea + +
      +
      +
      +
      +
      +
      +

      The area of the close button in the video controls as a percentage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var closeButtonArea: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + closeButtonPosition + +
      +
      +
      +
      +
      +
      +

      The position of the close button in the video controls.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var closeButtonPosition: Position { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + delegate + +
      +
      +
      +
      +
      +
      +

      A delegate for handling interactions with the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public weak var delegate: AnyObject?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adUnitConfig + +
      +
      +
      +
      +
      +
      +

      The configuration object for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public let adUnitConfig: AdUnitConfig
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a new BaseInterstitialAdUnit with the specified configuration ID, minimum size percentage, and event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      required public init(configID: String,
+                     minSizePerc: NSValue?,
+                     eventHandler: AnyObject?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minSizePerc + + +
      +

      The minimum size percentage for the ad unit.

      +
      +
      + + eventHandler + + +
      +

      An optional event handler object for handling ad events.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new BaseInterstitialAdUnit with the specified configuration ID, minimum size percentage, and event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configID: String,
+                        minSizePercentage: CGSize,
+                        eventHandler:AnyObject?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minSizePercentage + + +
      +

      The minimum size percentage for the ad unit.

      +
      +
      + + eventHandler + + +
      +

      An optional event handler object for handling ad events.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new BaseInterstitialAdUnit with the specified configuration ID and event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configID: String,
+                        eventHandler:AnyObject?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + eventHandler + + +
      +

      An optional event handler object for handling ad events.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new BaseInterstitialAdUnit with the specified configuration ID and minimum size percentage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configID: String,
+                        minSizePercentage:CGSize)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minSizePercentage + + +
      +

      The minimum size percentage for the ad unit.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configID:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new BaseInterstitialAdUnit with the specified configuration ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configID: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + loadAd() + +
      +
      +
      +
      +
      +
      +

      Loads a new ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func loadAd()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + show(from:) + +
      +
      +
      +
      +
      +
      +

      Shows the ad from a specified view controller.

      +
      +

      Note

      + This method must be called on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func show(from controller: UIViewController)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + controller + + +
      +

      The view controller from which the ad will be presented.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext Data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Adds context data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+@objc
+public func addContextData(_ data: String, forKey key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + data + + +
      +

      The data to add.

      +
      +
      + + key + + +
      +

      The key associated with the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Updates context data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+@objc
+public func updateContextData(_ data: Set<String>, forKey key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + data + + +
      +

      A set of data to update.

      +
      +
      + + key + + +
      +

      The key associated with the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes context data for a specified key.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+@objc
+public func removeContextDate(forKey key: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + key + + +
      +

      The key associated with the data to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      Clears all context data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+@objc
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addExtData(key: String, value: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the data.

      +
      +
      + + value + + +
      +

      The value for the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Updates ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + key + + +
      +

      The key for the data.

      +
      +
      + + value + + +
      +

      The value for the data.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeExtData(forKey: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + key + + +
      +

      The key for the data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      Clears ext data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Adds a context keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+@objc
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElement + + +
      +

      The keyword to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Adds a set of context keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+@objc
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElements + + +
      +

      A set of keywords to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a context keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+@objc
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + element + + +
      +

      The keyword to remove.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all context keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+@objc
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an extended keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElement + + +
      +

      The keyword to be added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      Adds multiple extended keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + newElements + + +
      +

      A set of keywords to be added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      Removes an extended keyword.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + element + + +
      +

      The keyword to be removed.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      Clears all extended keywords.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func setAppContent(_ appContent: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContent + + +
      +

      The app content data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the app content data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds app content data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      The data objects to be added.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes an app content data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeAppContentDataObject(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The data object to be removed.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all app content data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearAppContentDataObjects()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      The user data objects to be added.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a user data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The user data object to be removed.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    PBMInterstitialAdLoaderDelegate +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Internal delegate method.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialAdLoader(_ interstitialAdLoader: PBMInterstitialAdLoader,
+                                 loadedAd showBlock: @escaping (UIViewController?) -> Void,
+                                 isReadyBlock: @escaping () -> Bool)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Internal delegate method.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialAdLoader(_ interstitialAdLoader: PBMInterstitialAdLoader,
+                                 createdInterstitialController interstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + eventHandler + +
      +
      +
      +
      +
      +
      +

      The event handler for the interstitial events.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var eventHandler: Any?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    AdLoadFlowControllerDelegate +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Called when the ad load flow controller is about to send a bid request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowControllerWillSendBidRequest(_ adLoadFlowController: PBMAdLoadFlowController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad load flow controller is about to request the primary ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowControllerWillRequestPrimaryAd(_ adLoadFlowController: PBMAdLoadFlowController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called to determine if the ad load flow controller should continue with the current flow.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowControllerShouldContinue(_ adLoadFlowController: PBMAdLoadFlowController) -> Bool
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad load flow controller fails with an error.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adLoadFlowController(_ adLoadFlowController: PBMAdLoadFlowController, failedWithError error: Error?)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    InterstitialControllerInteractionDelegate +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Tracks an impression for the given interstitial controller.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func trackImpression(forInterstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad in the interstitial controller is clicked.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialControllerDidClickAd(_ interstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad in the interstitial controller is closed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialControllerDidCloseAd(_ interstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad in the interstitial controller causes the app to leave.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialControllerDidLeaveApp(_ interstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the interstitial controller displays an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialControllerDidDisplay(_ interstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the interstitial controller completes the ad display.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func interstitialControllerDidComplete(_ interstitialController: InterstitialController)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Provides the view controller to use for modal presentation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func viewControllerForModalPresentation(fromInterstitialController: InterstitialController) -> UIViewController?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    InterstitialEventInteractionDelegate +

    +
    +
    +
      +
    • +
      + + + + willPresentAd() + +
      +
      +
      +
      +
      +
      +

      Called when an ad is about to be presented.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func willPresentAd()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + didDismissAd() + +
      +
      +
      +
      +
      +
      +

      Called when an ad has been dismissed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func didDismissAd()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + willLeaveApp() + +
      +
      +
      +
      +
      +
      +

      Called when the ad causes the app to leave.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func willLeaveApp()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + didClickAd() + +
      +
      +
      +
      +
      +
      +

      Called when an ad is clicked.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func didClickAd()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    BaseInterstitialAdUnitProtocol +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Requests an ad using the provided bid response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_requestAd(with bidResponse: BidResponse?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Displays the ad using the provided view controller.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_show(from controller: UIViewController?)
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Abstract Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Checks if the ad unit is ready to show an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_isReady() -> Bool
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that an ad has been successfully received.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callDelegate_didReceiveAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that the ad failed to load.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callDelegate_didFailToReceiveAd(with: Error?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that an ad is about to be presented.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callDelegate_willPresentAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that an ad has been dismissed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callDelegate_didDismissAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that the app is about to leave due to an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callDelegate_willLeaveApplication()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Notifies the delegate that an ad has been clicked.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callDelegate_didClickAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the loading delegate for the event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_setLoadingDelegate(_ loadingDelegate: NSObject?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the interaction delegate for the event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_setInteractionDelegate()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Shows the ad from the provided view controller.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_showFromViewController(controller: UIViewController?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Tracks an impression for the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func callEventHandler_trackImpression()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BidInfo.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BidInfo.html new file mode 100644 index 000000000..f174ca333 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/BidInfo.html @@ -0,0 +1,631 @@ + + + + BidInfo Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    BidInfo

    +
    +
    + + 
    @objcMembers
+@objc(PBMBidInfo)
+public class BidInfo : NSObject
    + +
    +
    +

    Contains information about bid.

    + +
    +
    +
    +
      +
    • +
      + + + + EVENT_WIN + +
      +
      +
      +
      +
      +
      +

      Key to get Prebid win event from events

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let EVENT_WIN: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + EVENT_IMP + +
      +
      +
      +
      +
      +
      +

      Key to get Prebid imp event from events

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let EVENT_IMP: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + resultCode + +
      +
      +
      +
      +
      +
      +

      The result code of the bid request

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var resultCode: ResultCode { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + targetingKeywords + +
      +
      +
      +
      +
      +
      +

      Targeting keywords associated with the bid

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var targetingKeywords: [String : String]? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + exp + +
      +
      +
      +
      +
      +
      +

      The expiration time of the bid

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var exp: Double? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + nativeAdCacheId + +
      +
      +
      +
      +
      +
      +

      The cache ID for native ads

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var nativeAdCacheId: String? { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + events + +
      +
      +
      +
      +
      +
      +

      Events related to the bid

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public private(set) var events: [String : String] { get }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new BidInfo instance with the specified parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(resultCode: ResultCode, targetingKeywords: [String : String]? = nil, exp: Double? = nil,
+            nativeAdCacheId: String? = nil, events: [String: String] = [:])
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + +
      + + resultCode + + +
      +

      The result code of the bid request.

      +
      +
      + + targetingKeywords + + +
      +

      Optional targeting keywords associated with the bid.

      +
      +
      + + exp + + +
      +

      Optional expiration time of the bid.

      +
      +
      + + nativeAdCacheId + + +
      +

      Optional cache ID for native ads.

      +
      +
      + + events + + +
      +

      Optional dictionary of events related to the bid.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + getExp() + +
      +
      +
      +
      +
      +
      +

      Retrieves the expiration time of the bid as an NSNumber.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getExp() -> NSNumber?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ContextSubType.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ContextSubType.html new file mode 100644 index 000000000..e5cdeb2cf --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ContextSubType.html @@ -0,0 +1,670 @@ + + + + ContextSubType Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    ContextSubType

    +
    +
    + + 
    @objcMembers
+public class ContextSubType : SingleContainerInt
    + +
    +
    +

    Native context subtype asset.

    + +
    +
    +
    +
      +
    • +
      + + + + General + +
      +
      +
      +
      +
      +
      +

      Represents a general context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let General: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Article + +
      +
      +
      +
      +
      +
      +

      Represents an article context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Article: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Video + +
      +
      +
      +
      +
      +
      +

      Represents a video context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Video: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Audio + +
      +
      +
      +
      +
      +
      +

      Represents an audio context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Audio: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Image + +
      +
      +
      +
      +
      +
      +

      Represents an image context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Image: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + UserGenerated + +
      +
      +
      +
      +
      +
      +

      Represents a user-generated content context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let UserGenerated: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Social + +
      +
      +
      +
      +
      +
      +

      Represents a social media context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Social: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + email + +
      +
      +
      +
      +
      +
      +

      Represents an email context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let email: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + chatIM + +
      +
      +
      +
      +
      +
      +

      Represents a chat or instant messaging context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let chatIM: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + SellingProduct + +
      +
      +
      +
      +
      +
      +

      Represents a product selling context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let SellingProduct: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + AppStore + +
      +
      +
      +
      +
      +
      +

      Represents an App Store context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let AppStore: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ReviewSite + +
      +
      +
      +
      +
      +
      +

      Represents a review site context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let ReviewSite: ContextSubType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Represents a custom context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Custom: ContextSubType
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ContextType.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ContextType.html new file mode 100644 index 000000000..fafafb270 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ContextType.html @@ -0,0 +1,427 @@ + + + + ContextType Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    ContextType

    +
    +
    + + 
    @objcMembers
+public class ContextType : SingleContainerInt
    + +
    +
    +

    Native context type asset.

    + +
    +
    +
    +
      +
    • +
      + + + + Content + +
      +
      +
      +
      +
      +
      +

      Represents a content context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Content: ContextType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Social + +
      +
      +
      +
      +
      +
      +

      Represents a social media context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Social: ContextType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Product + +
      +
      +
      +
      +
      +
      +

      Represents a product context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Product: ContextType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Represents a custom context type.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let Custom: ContextType
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/EventTracking.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/EventTracking.html new file mode 100644 index 000000000..b3f95d6b5 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/EventTracking.html @@ -0,0 +1,402 @@ + + + + EventTracking Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    EventTracking

    +
    +
    + + 
    public class EventTracking : SingleContainerInt
    + +
    +
    +

    Native event tracking type.

    + +
    +
    +
    +
      +
    • +
      + + + + Image + +
      +
      +
      +
      +
      +
      +

      Represents image-based event tracking.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Image: EventTracking
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + js + +
      +
      +
      +
      +
      +
      +

      Represents JavaScript-based event tracking.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let js: EventTracking
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Represents a custom event tracking method.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Custom: EventTracking
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/EventType.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/EventType.html new file mode 100644 index 000000000..8bb1e7635 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/EventType.html @@ -0,0 +1,458 @@ + + + + EventType Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    EventType

    +
    +
    + + 
    public class EventType : SingleContainerInt
    + +
    +
    +

    Class representing different event types.

    + +
    +
    +
    +
      +
    • +
      + + + + Impression + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Impression: EventType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ViewableImpression50 + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let ViewableImpression50: EventType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ViewableImpression100 + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let ViewableImpression100: EventType
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let ViewableVideoImpression50: EventType
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Custom: EventType
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ExternalUserId.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ExternalUserId.html new file mode 100644 index 000000000..0d7256cec --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ExternalUserId.html @@ -0,0 +1,643 @@ + + + + ExternalUserId Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    ExternalUserId

    +
    +
    + + 
    @objcMembers
+public class ExternalUserId : NSObject, NSCoding, NSSecureCoding, JSONConvertible
    + +
    +
    +

    Defines the User Id Object from an External Thrid Party Source

    + +
    +
    +
    +
      +
    • +
      + + + + supportsSecureCoding + +
      +
      +
      +
      +
      +
      +

      Indicates whether the class supports secure coding.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static var supportsSecureCoding: Bool { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + source + +
      +
      +
      +
      +
      +
      +

      The source of the external user ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var source: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + identifier + +
      +
      +
      +
      +
      +
      +

      The identifier of the external user ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var identifier: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + atype + +
      +
      +
      +
      +
      +
      +

      The type of the external user ID, represented as an optional NSNumber.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var atype: NSNumber?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ext + +
      +
      +
      +
      +
      +
      +

      Additional attributes related to the external user ID, represented as an optional dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ext: [String : Any]?
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Initialization +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initialize ExternalUserId Class

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(source: String, identifier: String, atype: NSNumber? = nil, ext: [String : Any]? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + +
      + + source + + +
      +

      Source of the External User Id String.

      +
      +
      + + identifier + + +
      +

      String of the External User Id.

      +
      +
      + + atype + + +
      +

      (Optional) Int of the External User Id.

      +
      +
      + + ext + + +
      +

      (Optional) Dictionary of the External User Id.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + encode(with:) + +
      +
      +
      +
      +
      +
      +

      Encodes the properties of the class using the given encoder.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func encode(with coder: NSCoder)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(coder:) + +
      +
      +
      +
      +
      +
      +

      Initializes an ExternalUserId instance from the given decoder.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public required init?(coder: NSCoder)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + toJSONDictionary() + +
      +
      +
      +
      +
      +
      +

      Converts the ExternalUserId instance to a JSON dictionary.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func toJSONDictionary() -> [AnyHashable : Any]
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Host.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Host.html new file mode 100644 index 000000000..3b212e077 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Host.html @@ -0,0 +1,428 @@ + + + + Host Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    Host

    +
    +
    + + 
    @objcMembers
+public class Host : NSObject
    + +
    +
    +

    A singleton class that manages the Prebid server URL, including a custom URL.

    + +
    +
    +
    +
      +
    • +
      + + + + shared + +
      +
      +
      +
      +
      +
      +

      The class is created as a singleton object & used

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public static let shared: Host
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + setCustomHostURL(_:) + +
      +
      +
      +
      +
      +
      +

      The CustomHost property holds the URL for the custom prebid adaptor

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public func setCustomHostURL(_ urlString: String?) throws
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + getHostURL(host:) + +
      +
      +
      +
      +
      +
      +

      This function retrieves the prebid server URL for the selected host

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getHostURL(host: PrebidHost) throws -> String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + verifyUrl(urlString:) + +
      +
      +
      +
      +
      +
      +

      This function verifies if the prebid server URL is in the url format

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func verifyUrl(urlString: String?) -> Bool
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ImageAsset.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ImageAsset.html new file mode 100644 index 000000000..41c974407 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/ImageAsset.html @@ -0,0 +1,402 @@ + + + + ImageAsset Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    ImageAsset

    +
    +
    + + 
    public class ImageAsset : SingleContainerInt
    + +
    +
    +

    Native image asset type.

    + +
    +
    +
    +
      +
    • +
      + + + + Icon + +
      +
      +
      +
      +
      +
      +

      Represents an icon image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Icon: ImageAsset
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Main + +
      +
      +
      +
      +
      +
      +

      Represents the main image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Main: ImageAsset
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + Custom + +
      +
      +
      +
      +
      +
      +

      Represents a custom image asset.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public static let Custom: ImageAsset
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InstreamVideoAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InstreamVideoAdUnit.html new file mode 100644 index 000000000..32a441470 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InstreamVideoAdUnit.html @@ -0,0 +1,403 @@ + + + + InstreamVideoAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    InstreamVideoAdUnit

    +
    +
    + + 
    public class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
    + +
    +
    +

    Represents an instream video ad unit for original type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      The video parameters for this ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var videoParameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:size:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new instream video ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String, size: CGSize)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configId + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + size + + +
      +

      The size of the ad.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InterstitialAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InterstitialAdUnit.html new file mode 100644 index 000000000..05a725603 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InterstitialAdUnit.html @@ -0,0 +1,543 @@ + + + + InterstitialAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    InterstitialAdUnit

    +
    +
    + + 
    public class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
    + +
    +
    +

    Represents an interstitial ad unit built for original type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + parameters + +
      +
      +
      +
      +
      +
      +

      The deprecated banner parameters for this ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This property is deprecated. Please, use bannerParameters instead.")
+public var parameters: BannerParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + bannerParameters + +
      +
      +
      +
      +
      +
      +

      The banner parameters for this ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var bannerParameters: BannerParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      The video parameters for this ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var videoParameters: VideoParameters { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adFormats + +
      +
      +
      +
      +
      +
      +

      The ad formats for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adFormats: Set<AdFormat> { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configId:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new interstitial ad unit with a unique configuration identifier.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configId + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new interstitial ad unit with a minimum width and height percentage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public convenience init(configId: String, minWidthPerc: Int, minHeightPerc: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configId + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minWidthPerc + + +
      +

      The minimum width percentage of the ad.

      +
      +
      + + minHeightPerc + + +
      +

      The minimum height percentage of the ad.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InterstitialRenderingAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InterstitialRenderingAdUnit.html new file mode 100644 index 000000000..25fb60413 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/InterstitialRenderingAdUnit.html @@ -0,0 +1,917 @@ + + + + InterstitialRenderingAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    InterstitialRenderingAdUnit

    +
    +
    + + 
    @objcMembers
+public class InterstitialRenderingAdUnit : BaseInterstitialAdUnit
    + +
    +
    +

    Represents an interstitial ad unit. Built for rendering type of integration.

    + +
    +
    +
    +
      +
    • +
      + + + + skipButtonArea + +
      +
      +
      +
      +
      +
      +

      The area of the skip button in the video controls, specified as a percentage of the screen width.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var skipButtonArea: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipButtonPosition + +
      +
      +
      +
      +
      +
      +

      The position of the skip button in the video controls.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var skipButtonPosition: Position { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipDelay + +
      +
      +
      +
      +
      +
      +

      The delay before the skip button appears, in seconds.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public var skipDelay: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init(configID:) + +
      +
      +
      +
      +
      +
      +

      Initializes a new interstitial rendering ad unit with the specified configuration ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public init(configID: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new interstitial rendering ad unit with the specified configuration ID and minimum size percentage.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public init(configID: String, minSizePercentage: CGSize)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minSizePercentage + + +
      +

      The minimum size percentage of the ad.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new interstitial rendering ad unit with the specified configuration ID, minimum size percentage, and event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc
+public init(configID: String, minSizePercentage: CGSize, eventHandler: AnyObject)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minSizePercentage + + +
      +

      The minimum size percentage of the ad.

      +
      +
      + + eventHandler + + +
      +

      The event handler to manage ad events.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Protected overrides +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Called when an ad is successfully received.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didReceiveAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad fails to be received.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didFailToReceiveAd(with error: Error?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad will be presented.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_willPresentAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad is dismissed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didDismissAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the user will leave the application.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_willLeaveApplication()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Called when the ad is clicked.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callDelegate_didClickAd()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Checks if the ad is ready to be displayed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_isReady() -> Bool
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the loading delegate for the event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_setLoadingDelegate(_ loadingDelegate: NSObject?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the interaction delegate for the event handler.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_setInteractionDelegate()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Requests an ad with the specified bid response

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_requestAd(with bidResponse: BidResponse?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Shows the ad from the specified view controller.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_show(from controller: UIViewController?)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Tracks an impression for the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override func callEventHandler_trackImpression()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationBannerAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationBannerAdUnit.html new file mode 100644 index 000000000..e1cfa73e1 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationBannerAdUnit.html @@ -0,0 +1,1633 @@ + + + + MediationBannerAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    MediationBannerAdUnit

    +
    +
    + + 
    @objcMembers
+public class MediationBannerAdUnit : NSObject
    + +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + +
    +
    +
    +
      +
    • +
      + + + + mediationDelegate + +
      +
      +
      +
      +
      +
      +

      Property that performs certain utilty work for the MediationBannerAdUnit

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public let mediationDelegate: PrebidMediationDelegate
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Computed properties +

    +
    +
    +
      +
    • +
      + + + + configID + +
      +
      +
      +
      +
      +
      +

      The configuration ID for an ad unit

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var configID: String { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adFormat + +
      +
      +
      +
      +
      +
      +

      The ad format for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adFormat: AdFormat { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + adPosition + +
      +
      +
      +
      +
      +
      +

      The position of the ad on the screen.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adPosition: AdPosition { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + bannerParameters + +
      +
      +
      +
      +
      +
      +

      Parameters for configuring banner ads.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var bannerParameters: BannerParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      Parameters for configuring video ads.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var videoParameters: VideoParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + refreshInterval + +
      +
      +
      +
      +
      +
      +

      The refresh interval for the ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var refreshInterval: TimeInterval { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + additionalSizes + +
      +
      +
      +
      +
      +
      +

      Additional sizes for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var additionalSizes: [CGSize]? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ortbConfig + +
      +
      +
      +
      +
      +
      +

      OpenRTB configuration

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ortbConfig: String? { get set }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext Data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & value for adunit context targeting +if the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & values for adunit context targeting +the values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context data keyword & values set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all context data set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & values for adunit targeting. +The values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific ext data keyword & values set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all ext data set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context keyword from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method allows to remove specific keyword from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content object, replacing any existing content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAppContent(_ appContentObject: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContentObject + + +
      +

      The PBMORTBAppContent object representing the app’s content.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + getAppContent() + +
      +
      +
      +
      +
      +
      +

      Retrieves the current app content object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getAppContent() -> PBMORTBAppContent?
      + +
      +
      +
      +

      Return Value

      +

      The current PBMORTBAppContent object, or nil if no content is set.

      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the current app content object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of content data objects to the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      An array of PBMORTBContentData objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a specific content data object from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppContentData(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The PBMORTBContentData object to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContentData() + +
      +
      +
      +
      +
      +
      +

      Clears all content data objects from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContentData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      An array of PBMORTBContentData objects to add to the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a specific user data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The PBMORTBContentData object to remove from the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a new mediation banner ad unit with the specified configuration ID, size, and mediation delegate.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configID: String, size: CGSize, mediationDelegate: PrebidMediationDelegate)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configID + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + size + + +
      +

      The size of the ad.

      +
      +
      + + mediationDelegate + + +
      +

      The delegate for handling mediation.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request and setups mediation parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchDemand(completion: ((ResultCode) -> Void)?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      The completion handler to call when the demand fetch is complete.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + stopRefresh() + +
      +
      +
      +
      +
      +
      +

      Stops the auto-refresh for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func stopRefresh()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Handles the event when the ad object fails to load an ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func adObjectDidFailToLoadAd(adObject: UIView,
+                                    with error: Error)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + adObject + + +
      +

      The ad object that failed to load the ad.

      +
      +
      + + error + + +
      +

      The error that occurred during the ad load.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationBaseInterstitialAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationBaseInterstitialAdUnit.html new file mode 100644 index 000000000..dd22c2b74 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationBaseInterstitialAdUnit.html @@ -0,0 +1,1392 @@ + + + + MediationBaseInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    MediationBaseInterstitialAdUnit

    +
    +
    + + 
    @objcMembers
+public class MediationBaseInterstitialAdUnit : NSObject
    + +
    +
    +

    Base class for interstitial ads in Mediation API.

    + +
    +
    +
    +
      +
    • +
      + + + + bannerParameters + +
      +
      +
      +
      +
      +
      +

      Parameters for configuring banner ads.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var bannerParameters: BannerParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + videoParameters + +
      +
      +
      +
      +
      +
      +

      Parameters for configuring video ads.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var videoParameters: VideoParameters { get }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isMuted + +
      +
      +
      +
      +
      +
      +

      Indicates whether the video ad is muted.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var isMuted: Bool { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isSoundButtonVisible + +
      +
      +
      +
      +
      +
      +

      Indicates whether the sound button is visible in the video ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var isSoundButtonVisible: Bool { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + closeButtonArea + +
      +
      +
      +
      +
      +
      +

      The area for the close button in the video ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var closeButtonArea: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + closeButtonPosition + +
      +
      +
      +
      +
      +
      +

      The position of the close button in the video ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var closeButtonPosition: Position { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + ortbConfig + +
      +
      +
      +
      +
      +
      +

      OpenRTB configuration for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var ortbConfig: String? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + configId + +
      +
      +
      +
      +
      +
      +

      The configuration ID for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var configId: String { get }
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request and setups mediation parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchDemand(completion: ((ResultCode) -> Void)?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      A closure called with the result code indicating the outcome of the demand fetch.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext Data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & value for adunit context targeting +if the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & values for adunit context targeting +the values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context data keyword & values set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all context data set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & values for adunit targeting. +The values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific ext data keyword & values set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all ext data set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context keyword from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method allows to remove specific keyword from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content object, replacing any existing content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAppContent(_ appContentObject: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContentObject + + +
      +

      The PBMORTBAppContent object representing the app’s content.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the current app content object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of content data objects to the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      An array of PBMORTBContentData objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a specific content data object from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppContentData(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The PBMORTBContentData object to remove.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContentData() + +
      +
      +
      +
      +
      +
      +

      Clears all content data objects from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContentData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      An array of PBMORTBContentData objects to add to the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a specific user data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The PBMORTBContentData object to remove from the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationInterstitialAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationInterstitialAdUnit.html new file mode 100644 index 000000000..779226cb9 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationInterstitialAdUnit.html @@ -0,0 +1,645 @@ + + + + MediationInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    MediationInterstitialAdUnit

    +
    +
    + + 
    @objcMembers
+public class MediationInterstitialAdUnit : MediationBaseInterstitialAdUnit
    + +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + +
    +
    +
    +
    + + +
    + +

    Public Properties +

    +
    +
    +
      +
    • +
      + + + + adFormats + +
      +
      +
      +
      +
      +
      +

      The ad format for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var adFormats: Set<AdFormat> { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + additionalSizes + +
      +
      +
      +
      +
      +
      +

      Additional sizes for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var additionalSizes: [CGSize]? { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipButtonArea + +
      +
      +
      +
      +
      +
      +

      The area for the skip button in the video ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var skipButtonArea: Double { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipButtonPosition + +
      +
      +
      +
      +
      +
      +

      The position of the skip button in the video ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var skipButtonPosition: Position { get set }
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + skipDelay + +
      +
      +
      +
      +
      +
      +

      The delay before the skip button appears in the video ad.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var skipDelay: Double { get set }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Convenience initializer for the mediation interstitial ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override convenience init(configId: String, mediationDelegate: PrebidMediationDelegate)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configId + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + mediationDelegate + + +
      +

      The delegate for handling mediation.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Initializes a new mediation interstitial ad unit with the specified configuration ID, minimum size percentage, and mediation delegate.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String, minSizePercentage: CGSize?, mediationDelegate: PrebidMediationDelegate)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + configId + + +
      +

      The unique identifier for the ad unit configuration.

      +
      +
      + + minSizePercentage + + +
      +

      The minimum size percentage for the ad.

      +
      +
      + + mediationDelegate + + +
      +

      The delegate for handling mediation.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Computed Properties +

    +
    +
    +
      +
    • +
      + + + + configId + +
      +
      +
      +
      +
      +
      +

      The configuration ID for the ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override var configId: String { get }
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationNativeAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationNativeAdUnit.html new file mode 100644 index 000000000..477bea6b2 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationNativeAdUnit.html @@ -0,0 +1,1840 @@ + + + + MediationNativeAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    MediationNativeAdUnit

    +
    +
    + + 
    @objcMembers
+public class MediationNativeAdUnit : NSObject
    + +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + +
    +
    +
    +
    + + +
    + +

    Public Properties +

    +
    +
    +
      +
    • +
      + + + + nativeAdUnit + +
      +
      +
      +
      +
      +
      +

      The native ad unit that makes native request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var nativeAdUnit: NativeRequest
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a new instance of the MediationNativeAdUnit with the specified configuration ID and mediation delegate.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(configId: String, mediationDelegate: PrebidMediationDelegate)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + mediationDelegate + + +
      +

      The delegate for mediation-related tasks.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addEventTracker(_:) + +
      +
      +
      +
      +
      +
      +

      Adds event trackers to the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addEventTracker(_ eventTrackers: [NativeEventTracker])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + eventTrackers + + +
      +

      An array of NativeEventTracker objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + addNativeAssets(_:) + +
      +
      +
      +
      +
      +
      +

      Adds native assets to the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addNativeAssets(_ assets: [NativeAsset])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + assets + + +
      +

      An array of NativeAsset objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setContextType(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the context type for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setContextType(_ contextType: ContextType)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + contextType + + +
      +

      The context type to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setPlacementType(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the placement type for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setPlacementType(_ placementType: PlacementType)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + placementType + + +
      +

      The placement type to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setPlacementCount(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the placement count for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setPlacementCount(_ placementCount: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + placementCount + + +
      +

      The placement count to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setContextSubType(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the context subtype for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setContextSubType(_ contextSubType: ContextSubType)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + contextSubType + + +
      +

      The context subtype to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setSequence(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the sequence for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setSequence(_ sequence: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + sequence + + +
      +

      The sequence to set.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Sets the asset URL support for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAssetURLSupport(_ assetURLSupport: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + assetURLSupport + + +
      +

      The asset URL support value to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setDURLSupport(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the DURL support for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setDURLSupport(_ dURLSupport: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dURLSupport + + +
      +

      The DURL support value to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setPrivacy(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the privacy value for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setPrivacy(_ privacy: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + privacy + + +
      +

      The privacy value to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + setExt(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the extended data for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setExt(_ ext: [String : Any])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + ext + + +
      +

      A dictionary containing the extended data to set.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + getOrtbConfig() + +
      +
      +
      +
      +
      +
      +

      Retrieves the OpenRTB configuration for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func getOrtbConfig() -> String?
      + +
      +
      +
      +

      Return Value

      +

      The OpenRTB configuration as a string, or nil if not set.

      +
      +
      +
      +
      • +
    • +
      + + + + setOrtbConfig(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the OpenRTB configuration for the native ad unit.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setOrtbConfig(_ ortbConfig: String?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + ortbConfig + + +
      +

      The OpenRTB configuration to set.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    App Content (app.content.data) +

    +
    +
    +
      +
    • +
      + + + + setAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Sets the app content object, replacing any existing content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func setAppContent(_ appContent: PBMORTBAppContent)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + appContent + + +
      +

      The PBMORTBAppContent object representing the app’s content.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearAppContent() + +
      +
      +
      +
      +
      +
      +

      Clears the current app content object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearAppContent()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addAppContentData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of content data objects to the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addAppContentData(_ dataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObjects + + +
      +

      An array of PBMORTBContentData objects to add.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeAppContent(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a specific content data object from the app content.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeAppContent(_ dataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + dataObject + + +
      +

      The PBMORTBContentData object to remove.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    User Data (user.data) +

    +
    +
    +
      +
    • +
      + + + + addUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Adds an array of user data objects.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addUserData(_ userDataObjects: [PBMORTBContentData])
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObjects + + +
      +

      An array of PBMORTBContentData objects to add to the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + removeUserData(_:) + +
      +
      +
      +
      +
      +
      +

      Removes a specific user data object.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeUserData(_ userDataObject: PBMORTBContentData)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + userDataObject + + +
      +

      The PBMORTBContentData object to remove from the user data.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearUserData() + +
      +
      +
      +
      +
      +
      +

      Clears all user data.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearUserData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext Data (imp[].ext.data) +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & value for adunit context targeting +if the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+public func addContextData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context data keyword & values for adunit context targeting +the values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context data keyword & values set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+public func removeContextData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearContextData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all context data set from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+public func clearContextData()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & value for adunit targeting. +If the key already exists the value will be appended to the list. No duplicates will be added

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtData(key: String, value: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the ext data keyword & values for adunit targeting. +The values if the key already exist will be replaced with the new set of values

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func updateExtData(key: String, value: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific ext data keyword & values set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtData(forKey: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtData() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all ext data set from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtData()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    Ext keywords (imp[].ext.keywords) +

    +
    +
    +
      +
    • +
      + + + + addContextKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the context keyword for adunit context targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method obtains the context keyword set for adunit context targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove specific context keyword from adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+public func removeContextKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit context targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+public func clearContextKeywords()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeyword(_ newElement: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + addExtKeywords(_:) + +
      +
      +
      +
      +
      +
      +

      This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func addExtKeywords(_ newElements: Set<String>)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + removeExtKeyword(_:) + +
      +
      +
      +
      +
      +
      +

      This method allows to remove specific keyword from adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func removeExtKeyword(_ element: String)
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + clearExtKeywords() + +
      +
      +
      +
      +
      +
      +

      This method allows to remove all keywords from the set of adunit targeting

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func clearExtKeywords()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Makes bid request for the native ad unit and setups mediation parameters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func fetchDemand(completion: ((ResultCode) -> Void)?)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      The completion handler to call with the result code.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationRewardedAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationRewardedAdUnit.html new file mode 100644 index 000000000..2af8aade6 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/MediationRewardedAdUnit.html @@ -0,0 +1,387 @@ + + + + MediationRewardedAdUnit Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    MediationRewardedAdUnit

    +
    +
    + + 
    @objcMembers
+public class MediationRewardedAdUnit : MediationBaseInterstitialAdUnit
    + +
    +
    +

    This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. +This class is a part of Mediation API.

    + +
    +
    +
    +
    + + +
    + +

    Public Methods +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a new instance of the MediationRewardedAdUnit with the specified configuration ID and mediation delegate.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init(configId: String, mediationDelegate: PrebidMediationDelegate)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + configId + + +
      +

      The configuration ID for the ad unit.

      +
      +
      + + mediationDelegate + + +
      +

      The delegate for mediation-related tasks.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAd.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAd.html new file mode 100644 index 000000000..28eb0d3fb --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAd.html @@ -0,0 +1,870 @@ + + + + NativeAd Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    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.

      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      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.

      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAdConfiguration.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAdConfiguration.html new file mode 100644 index 000000000..c56c861f4 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAdConfiguration.html @@ -0,0 +1,401 @@ + + + + NativeAdConfiguration Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAdConfiguration

    +
    +
    + + 
    @objc(PBMNativeAdConfiguration)
+@objcMembers
+public class NativeAdConfiguration : NSObject
    + +
    +
    +

    Represents the configuration for a native ad, including markup and version information.

    + +
    +
    +
    +
      +
    • +
      + + + + version + +
      +
      +
      +
      +
      +
      +

      Version of the Native Markup version in use.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var version: String
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + markupRequestObject + +
      +
      +
      +
      +
      +
      +

      The object containing the request details for the native markup.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var markupRequestObject: NativeMarkupRequestObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + init() + +
      +
      +
      +
      +
      +
      +

      Initializes a new instance of NativeAdMarkup with default values.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public override init()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAdMarkup.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAdMarkup.html new file mode 100644 index 000000000..b7c028eaf --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAdMarkup.html @@ -0,0 +1,726 @@ + + + + NativeAdMarkup Class Reference + + + + + + + + + + + + + +
    +
    +

    PrebidMobile 2.2.3 Docs (94% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NativeAdMarkup

    +
    +
    + + 
    @objcMembers
+public class NativeAdMarkup : NSObject, JsonDecodable
    + +
    +
    +

    Represents the markup for a native ad, including assets, tracking URLs, and other metadata.

    + +
    +
    +
    +
      +
    • +
      + + + + version + +
      +
      +
      +
      +
      +
      +

      Version of the Native Markup version in use.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var version: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + assets + +
      +
      +
      +
      +
      +
      +

      List of native ad’s assets. +Required if no assetsurl. +Recommended as fallback even if assetsurl is provided.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var assets: [NativeAdMarkupAsset]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + assetsurl + +
      +
      +
      +
      +
      +
      +

      URL of an alternate source for the assets object. +The expected response is a JSON object mirroring the assets object in the bid response, +subject to certain requirements as specified in the individual objects. +Where present, overrides the asset object in the response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var assetsurl: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + dcourl + +
      +
      +
      +
      +
      +
      +

      URL where a dynamic creative specification may be found for populating this ad, per the Dynamic Content Ads Specification. +Note this is a beta option as the interpretation of the Dynamic Content Ads Specification and how to assign those elements +into a native ad is outside the scope of this spec and must be agreed offline between the parties +or as may be specified in a future revision of the Dynamic Content Ads spec. +Where present, overrides the asset object in the response.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var dcourl: String?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + link + +
      +
      +
      +
      +
      +
      +

      Destination Link. +This is default link object for the ad. +Individual assets can also have a link object which applies if the asset is activated(clicked). +If the asset doesn’t have a link object, the parent link object applies. +See LinkObject Definition

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var link: NativeLink?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + imptrackers + +
      +
      +
      +
      +
      +
      +

      Array of impression tracking URLs, expected to return a 1x1 image or 204 response - typically only passed when using 3rd party trackers. +To be deprecated - replaced with eventtrackers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public var imptrackers: [String]?
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + jstracker + +
      +
      +
      +
      +
      +
      +

      Optional JavaScript impression tracker. +This is a valid HTML, Javascript is already wrapped in + + + + + + + + + +

      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAdMarkupAsset

      +
      +
      + + 
      @objcMembers
+public class NativeAdMarkupAsset : NSObject, JsonDecodable
      + +
      +
      +

      Represents an asset in the native ad markup, which can be a title, image, data, or link.

      + +
      +
      +
      +
        +
      • +
        + + + + id + +
        +
        +
        +
        +
        +
        +

        Optional if asseturl/dcourl is being used; required if embeded asset is being used

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var id: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + required + +
        +
        +
        +
        +
        +
        +

        Set to 1 if asset is required. (bidder requires it to be displayed).

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var required: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + title + +
        +
        +
        +
        +
        +
        +

        Title object for title assets. +See TitleObject definition.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var title: NativeTitle?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + img + +
        +
        +
        +
        +
        +
        +

        Image object for image assets. +See ImageObject definition.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var img: NativeImage?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + data + +
        +
        +
        +
        +
        +
        +

        Data object for ratings, prices etc.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var data: NativeData?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + link + +
        +
        +
        +
        +
        +
        +

        Link object for call to actions. +The link object applies if the asset item is activated (clicked). +If there is no link object on the asset, the parent link object on the bid response applies.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var link: NativeLink?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(jsonDictionary:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAdMarkupAsset from a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(jsonDictionary: [String : Any])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + jsonDictionary + + +
        +

        A dictionary representing the asset in the native ad markup.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAdMarkupAsset with default values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAsset.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAsset.html new file mode 100644 index 000000000..a1dc2e5c1 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAsset.html @@ -0,0 +1,391 @@ + + + + NativeAsset Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAsset

      +
      +
      + + 
      public class NativeAsset : NSObject
      + +
      +
      +

      Represents a generic native ad asset which could be a title, image, or data.

      + +
      +
      +
      +
        +
      • +
        + + + + required + +
        +
        +
        +
        +
        +
        +

        Indicates whether the asset is required for the ad to be considered valid.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var required: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(isRequired:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAsset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(isRequired: Bool)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + isRequired + + +
        +

        A boolean indicating whether the asset is required.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetData.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetData.html new file mode 100644 index 000000000..3d50f8dc2 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetData.html @@ -0,0 +1,431 @@ + + + + NativeAssetData Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAssetData

      +
      +
      + + 
      @objcMembers
+public class NativeAssetData : NativeAsset
      + +
      +
      +

      Represents a data asset in a native ad.

      + +
      +
      +
      +
        +
      • +
        + + + + length + +
        +
        +
        +
        +
        +
        +

        The length of the data asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var length: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        Additional custom properties for the data asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: AnyObject?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(type:required:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAssetData.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(type: DataAsset, required: Bool)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + type + + +
        +

        The type of the data asset.

        +
        +
        + + required + + +
        +

        A boolean indicating whether the asset is required.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetImage.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetImage.html new file mode 100644 index 000000000..2b9477a22 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetImage.html @@ -0,0 +1,624 @@ + + + + NativeAssetImage Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAssetImage

      +
      +
      + + 
      @objcMembers
+public class NativeAssetImage : NativeAsset
      + +
      +
      +

      Represents an image asset in a native ad.

      + +
      +
      +
      +
        +
      • +
        + + + + type + +
        +
        +
        +
        +
        +
        +

        The type of the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var type: ImageAsset?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + width + +
        +
        +
        +
        +
        +
        +

        The width of the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var width: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + widthMin + +
        +
        +
        +
        +
        +
        +

        The minimum width of the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var widthMin: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + height + +
        +
        +
        +
        +
        +
        +

        The height of the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var height: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + heightMin + +
        +
        +
        +
        +
        +
        +

        The minimum height of the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var heightMin: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + mimes + +
        +
        +
        +
        +
        +
        +

        The MIME types supported for the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var mimes: Array<String>?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        Additional custom properties for the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: AnyObject?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAssetImage.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public convenience init(minimumWidth: Int, minimumHeight: Int, required: Bool)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + + + + + +
        + + minimumWidth + + +
        +

        The minimum width of the image.

        +
        +
        + + minimumHeight + + +
        +

        The minimum height of the image.

        +
        +
        + + required + + +
        +

        A boolean indicating whether the asset is required.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init(isRequired:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAssetImage.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init(isRequired: Bool)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + isRequired + + +
        +

        A boolean indicating whether the asset is required.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetTitle.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetTitle.html new file mode 100644 index 000000000..df3ec37bb --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeAssetTitle.html @@ -0,0 +1,404 @@ + + + + NativeAssetTitle Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAssetTitle

      +
      +
      + + 
      @objcMembers
+public class NativeAssetTitle : NativeAsset
      + +
      +
      +

      Represents a title asset in a native ad.

      + +
      +
      +
      +
        +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        Additional custom properties for the title asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: AnyObject?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Initializes a new instance of NativeAssetTitle.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(length: NSInteger, required: Bool)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + length + + +
        +

        The maximum length of the title.

        +
        +
        + + required + + +
        +

        A boolean indicating whether the asset is required.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeData.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeData.html new file mode 100644 index 000000000..8c2b5155e --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeData.html @@ -0,0 +1,505 @@ + + + + NativeData Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeData

      +
      +
      + + 
      @objcMembers
+public class NativeData : NSObject, JsonDecodable
      + +
      +
      +

      Class representing native data elements in the ad markup.

      + +
      +
      +
      +
        +
      • +
        + + + + type + +
        +
        +
        +
        +
        +
        +

        The type of data element being submitted from the Data Asset Types table. +Required for assetsurl/dcourl responses, not required for embedded asset responses.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var type: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + length + +
        +
        +
        +
        +
        +
        +

        The length of the data element being submitted. +Required for assetsurl/dcourl responses, not required for embedded asset responses. +Where applicable, must comply with the recommended maximum lengths in the Data Asset Types table.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var length: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + value + +
        +
        +
        +
        +
        +
        +

        The formatted string of data to be displayed. +Can contain a formatted value such as “5 stars” or “$10” or “3.4 stars out of 5”.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var value: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(jsonDictionary:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new NativeData object with the provided JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(jsonDictionary: [String : Any])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + jsonDictionary + + +
        +

        A dictionary containing the JSON data to initialize the object.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeEventTracker.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeEventTracker.html new file mode 100644 index 000000000..dee3b286b --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeEventTracker.html @@ -0,0 +1,378 @@ + + + + NativeEventTracker Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeEventTracker

      +
      +
      + + 
      @objc
+public class NativeEventTracker : NSObject
      + +
      +
      +

      Class representing an event tracker for native ads.

      + +
      +
      +
      +
        +
      • +
        + + + + init(event:methods:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new NativeEventTracker instance.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public init(event: EventType, methods: Array<EventTracking>)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + event + + +
        +

        The event type to track.

        +
        +
        + + methods + + +
        +

        The methods used for tracking the event.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeEventTrackerResponse.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeEventTrackerResponse.html new file mode 100644 index 000000000..cf9a34f06 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeEventTrackerResponse.html @@ -0,0 +1,531 @@ + + + + NativeEventTrackerResponse Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeEventTrackerResponse

      +
      +
      + + 
      @objcMembers
+public class NativeEventTrackerResponse : NSObject, JsonDecodable
      + +
      +
      +

      Class representing a response for a native event tracker.

      + +
      +
      +
      +
        +
      • +
        + + + + event + +
        +
        +
        +
        +
        +
        +

        Type of event to track. +See Event Types table.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var event: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + method + +
        +
        +
        +
        +
        +
        +

        Type of tracking requested. +See Event Tracking Methods table.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var method: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + url + +
        +
        +
        +
        +
        +
        +

        The URL of the image or js. +Required for image or js, optional for custom.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var url: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + customdata + +
        +
        +
        +
        +
        +
        +

        To be agreed individually with the exchange, an array of key:value objects for custom tracking, +for example the account number of the DSP with a tracking company. IE {“accountnumber”:”123”}.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var customdata: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(jsonDictionary:) + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeEventTrackerResponse object from a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(jsonDictionary: [String : Any])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + jsonDictionary + + +
        +

        A dictionary containing the JSON data to initialize the object.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Initializes with default values

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeImage.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeImage.html new file mode 100644 index 000000000..afbea0bbf --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeImage.html @@ -0,0 +1,533 @@ + + + + NativeImage Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeImage

      +
      +
      + + 
      @objcMembers
+public class NativeImage : NSObject, JsonDecodable
      + +
      +
      +

      Class representing an image asset in a native ad.

      + +
      +
      +
      +
        +
      • +
        + + + + type + +
        +
        +
        +
        +
        +
        +

        The type of image element being submitted from the Image Asset Types table. +Required for assetsurl or dcourl responses, not required for embedded asset responses.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var type: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + url + +
        +
        +
        +
        +
        +
        +

        URL of the image asset.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var url: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + width + +
        +
        +
        +
        +
        +
        +

        Width of the image in pixels. +Recommended for embedded asset responses. +Required for assetsurl/dcourlresponses if multiple assets of same type submitted.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var width: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + height + +
        +
        +
        +
        +
        +
        +

        Height of the image in pixels. +Recommended for embedded asset responses. +Required for assetsurl/dcourl responses if multiple assets of same type submitted.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var height: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(jsonDictionary:) + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeImage object from a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(jsonDictionary: [String : Any])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + jsonDictionary + + +
        +

        A dictionary containing the JSON data to initialize the object.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Initializes with default values

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeLink.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeLink.html new file mode 100644 index 000000000..a8cd21371 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeLink.html @@ -0,0 +1,501 @@ + + + + NativeLink Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeLink

      +
      +
      + + 
      @objcMembers
+public class NativeLink : NSObject, JsonDecodable
      + +
      +
      +

      Class representing a link in a native ad.

      + +
      +
      +
      +
        +
      • +
        + + + + url + +
        +
        +
        +
        +
        +
        +

        Landing URL of the clickable link.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var url: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + clicktrackers + +
        +
        +
        +
        +
        +
        +

        List of third-party tracker URLs to be fired on click of the URL.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var clicktrackers: [String]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + fallback + +
        +
        +
        +
        +
        +
        +

        Fallback URL for deeplink. +To be used if the URL given in url is not supported by the device.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var fallback: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(jsonDictionary:) + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeLink object from a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(jsonDictionary: [String : Any])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + jsonDictionary + + +
        +

        A dictionary containing the JSON data to initialize the object.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Initializes with default values

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeMarkupRequestObject.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeMarkupRequestObject.html new file mode 100644 index 000000000..146b9ba0c --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeMarkupRequestObject.html @@ -0,0 +1,806 @@ + + + + NativeMarkupRequestObject Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeMarkupRequestObject

      +
      +
      + + 
      @objc(PBMNativeMarkupRequestObject)
+@objcMembers
+public class NativeMarkupRequestObject : NSObject, NSCopying, PBMJsonCodable
      + +
      +
      +

      Represents a request object for native markup, including details about the ad’s context, placement, and supported features.

      + +
      +
      +
      +
        +
      • +
        + + + + context + +
        +
        +
        +
        +
        +
        +

        [Recommended] +[Integer] +The context in which the ad appears. +See NativeContextType

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var context: ContextType?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + contextsubtype + +
        +
        +
        +
        +
        +
        +

        [Integer] +A more detailed context in which the ad appears. +See NativeContextSubtype

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var contextsubtype: ContextSubType?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + plcmttype + +
        +
        +
        +
        +
        +
        +

        [Recommended] +[Integer] +The design/format/layout of the ad unit being offered. +See NativePlacementType

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var plcmttype: PlacementType?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + plcmtcnt + +
        +
        +
        +
        +
        +
        +

        [Integer] +The number of identical placements in this Layout. Refer Section 8.1 Multiplacement Bid Requests for further detail.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var plcmtcnt: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + seq + +
        +
        +
        +
        +
        +
        +

        [Integer] +0 for the first ad, 1 for the second ad, and so on. +Note this would generally NOT be used in combination with plcmtcnt - +either you are auctioning multiple identical placements (in which case plcmtcnt>1, seq=0) +or you are holding separate auctions for distinct items in the feed (in which case plcmtcnt=1, seq=>=1)

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var seq: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + assets + +
        +
        +
        +
        +
        +
        +

        [Required] +An array of Asset Objects. Any objects bid response must comply with the array of elements expressed in the bid request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var assets: [NativeAsset]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + aurlsupport + +
        +
        +
        +
        +
        +
        +

        [Integer] +Whether the supply source / impression supports returning an assetsurl instead of an asset object. 0 or the absence of the field indicates no such support.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var aurlsupport: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + durlsupport + +
        +
        +
        +
        +
        +
        +

        [Integer] +Whether the supply source / impression supports returning a dco url instead of an asset object. 0 or the absence of the field indicates no such support. +Beta feature.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var durlsupport: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + eventtrackers + +
        +
        +
        +
        +
        +
        +

        Specifies what type of event objects tracking is supported - see Event Trackers Request Object

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var eventtrackers: [NativeEventTracker]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + privacy + +
        +
        +
        +
        +
        +
        +

        [Recommended] +[Integer] +Set to 1 when the native ad supports buyer-specific privacy notice. Set to 0 (or field absent) when the native ad doesn’t support custom privacy links or if support is unknown.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var privacy: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeMarkupRequestObject with default values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      NSCopying +

      +
      +
      +
        +
      • +
        + + + + copy(with:) + +
        +
        +
        +
        +
        +
        +

        Creates a copy of the current NativeMarkupRequestObject instance.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func copy(with zone: NSZone? = nil) -> Any
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + zone + + +
        +

        An optional zone for the copy operation.

        +
        +
        +
        +
        +

        Return Value

        +

        A copy of the NativeMarkupRequestObject instance.

        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      PBMJsonCodable +

      +
      +
      +
        +
      • +
        + + + + jsonDictionary + +
        +
        +
        +
        +
        +
        +

        Converts the NativeMarkupRequestObject instance to a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var jsonDictionary: [String : Any]? { get }
        + +
        +
        +
        +

        Return Value

        +

        A dictionary representation of the NativeMarkupRequestObject instance.

        +
        +
        +
        +
        • +
      • +
        + + + + toJsonString() + +
        +
        +
        +
        +
        +
        +

        Converts the NativeMarkupRequestObject instance to a JSON string.

        +
        +

        Throws

        + An error if the conversion to JSON string fails. + +
        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func toJsonString() throws -> String
        + +
        +
        +
        +

        Return Value

        +

        A JSON string representation of the NativeMarkupRequestObject instance.

        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeParameters.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeParameters.html new file mode 100644 index 000000000..34e5390e6 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeParameters.html @@ -0,0 +1,646 @@ + + + + NativeParameters Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeParameters

      +
      +
      + + 
      @objcMembers
+public class NativeParameters : NSObject
      + +
      +
      +

      Represents parameters for a native ad request, including assets, event trackers, and configuration settings.

      + +
      +
      +
      +
        +
      • +
        + + + + assets + +
        +
        +
        +
        +
        +
        +

        An array of NativeAsset objects representing the assets required for the native ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var assets: [NativeAsset]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + eventtrackers + +
        +
        +
        +
        +
        +
        +

        An array of NativeEventTracker objects specifying the event tracking settings for the native ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var eventtrackers: [NativeEventTracker]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + version + +
        +
        +
        +
        +
        +
        +

        The version of the native ad specification being used. Defaults to “1.2”.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var version: String
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + context + +
        +
        +
        +
        +
        +
        +

        The context in which the ad appears. See ContextType for possible values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var context: ContextType?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + contextSubType + +
        +
        +
        +
        +
        +
        +

        A more detailed context in which the ad appears. See ContextSubType for possible values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var contextSubType: ContextSubType?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + placementType + +
        +
        +
        +
        +
        +
        +

        The design/format/layout of the ad unit being offered. See PlacementType for possible values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var placementType: PlacementType?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + placementCount + +
        +
        +
        +
        +
        +
        +

        The number of identical placements in the ad layout. Defaults to 1.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var placementCount: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + sequence + +
        +
        +
        +
        +
        +
        +

        The sequence number of the ad. Defaults to 0.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var sequence: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + asseturlsupport + +
        +
        +
        +
        +
        +
        +

        Indicates whether the supply source/impression supports returning an assetsurl instead of an asset object. +Defaults to 0, indicating no support.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var asseturlsupport: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + durlsupport + +
        +
        +
        +
        +
        +
        +

        Indicates whether the supply source/impression supports returning a dco URL instead of an asset object. +Defaults to 0, indicating no support.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var durlsupport: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + privacy + +
        +
        +
        +
        +
        +
        +

        Indicates whether the supply source/impression supports returning a dco URL instead of an asset object. +Defaults to 0, indicating no support.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var privacy: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        A placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeRequest.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeRequest.html new file mode 100644 index 000000000..32494e5b3 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeRequest.html @@ -0,0 +1,910 @@ + + + + NativeRequest Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeRequest

      +
      +
      + + 
      public class NativeRequest : AdUnit
      + +
      +
      +

      A class representing a native request for original type of integration.

      + +
      +
      +
      +
        +
      • +
        + + + + version + +
        +
        +
        +
        +
        +
        +

        The version of the native ad specification being used. Defaults to “1.2” if not set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var version: String { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + context + +
        +
        +
        +
        +
        +
        +

        The context in which the ad appears. See ContextType for possible values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var context: ContextType? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + contextSubType + +
        +
        +
        +
        +
        +
        +

        A more detailed context in which the ad appears. See ContextSubType for possible values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var contextSubType: ContextSubType? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + placementType + +
        +
        +
        +
        +
        +
        +

        The design/format/layout of the ad unit being offered. See PlacementType for possible values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var placementType: PlacementType? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + placementCount + +
        +
        +
        +
        +
        +
        +

        The number of identical placements in the ad layout. Defaults to 1 if not set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var placementCount: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + sequence + +
        +
        +
        +
        +
        +
        +

        The sequence number of the ad. Defaults to 0 if not set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var sequence: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + assets + +
        +
        +
        +
        +
        +
        +

        An array of NativeAsset objects representing the assets required for the native ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var assets: [NativeAsset]? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + asseturlsupport + +
        +
        +
        +
        +
        +
        +

        Indicates whether the supply source/impression supports returning an assetsurl instead of an asset object. +Defaults to 0 if not set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var asseturlsupport: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + durlsupport + +
        +
        +
        +
        +
        +
        +

        Indicates whether the supply source/impression supports returning a dco URL instead of an asset object. +Defaults to 0 if not set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var durlsupport: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + eventtrackers + +
        +
        +
        +
        +
        +
        +

        An array of NativeEventTracker objects specifying the event tracking settings for the native ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var eventtrackers: [NativeEventTracker]? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + privacy + +
        +
        +
        +
        +
        +
        +

        Indicates whether the native ad supports a buyer-specific privacy notice. Defaults to 0 if not set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var privacy: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        A placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + configId + +
        +
        +
        +
        +
        +
        +

        The configuration ID for the ad unit.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var configId: String { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(configId:) + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeRequest with a specified configuration ID.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(configId: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Initializes a NativeRequest with a specified configuration ID, assets, and event trackers.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public convenience init(configId: String, assets: [NativeAsset]? = nil, eventTrackers: [NativeEventTracker]? = nil)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        + + assets + + +
        +

        An optional array of NativeAsset objects.

        +
        +
        + + eventTrackers + + +
        +

        An optional array of NativeEventTracker objects.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + addNativeAssets(_:) + +
        +
        +
        +
        +
        +
        +

        Adds an array of native assets to the request. If assets already exist, they will be appended.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addNativeAssets(_ assets: [NativeAsset])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + assets + + +
        +

        An array of NativeAsset objects to add.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Adds an array of native event trackers to the request. If event trackers already exist, they will be appended.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addNativeEventTracker(_ eventTrackers: [NativeEventTracker])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + eventTrackers + + +
        +

        An array of NativeEventTracker objects to add.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Retrieves the native request object as a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getNativeRequestObject() -> [AnyHashable : Any]?
        + +
        +
        +
        +

        Return Value

        +

        A dictionary representation of the native request object, or nil if an error occurs.

        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeTitle.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeTitle.html new file mode 100644 index 000000000..f544200c5 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/NativeTitle.html @@ -0,0 +1,475 @@ + + + + NativeTitle Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeTitle

      +
      +
      + + 
      @objcMembers
+public class NativeTitle : NSObject, JsonDecodable
      + +
      +
      +

      Represents the title element in a native ad, including optional text and length.

      + +
      +
      +
      +
        +
      • +
        + + + + text + +
        +
        +
        +
        +
        +
        +

        The text associated with the text element.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var text: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + length + +
        +
        +
        +
        +
        +
        +

        The length of the title being provided. +Required if using assetsurl/dcourl representation, optional if using embedded asset representation.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var length: Int?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ext + +
        +
        +
        +
        +
        +
        +

        This object is a placeholder that may contain custom JSON agreed to by the parties to support +flexibility beyond the standard defined in this specification

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var ext: [String : Any]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(jsonDictionary:) + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeTitle object from a JSON dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public required init(jsonDictionary: [String : Any])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + jsonDictionary + + +
        +

        A dictionary containing the JSON representation of the title.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init() + +
        +
        +
        +
        +
        +
        +

        Initializes a NativeTitle object with default values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override init()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PlacementType.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PlacementType.html new file mode 100644 index 000000000..661bf822c --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PlacementType.html @@ -0,0 +1,454 @@ + + + + PlacementType Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PlacementType

      +
      +
      + + 
      @objcMembers
+public class PlacementType : SingleContainerInt
      + +
      +
      +

      Represents different types of placements for native ads.

      + +
      +
      +
      +
        +
      • +
        + + + + FeedContent + +
        +
        +
        +
        +
        +
        +

        Placement type indicating the ad appears within feed content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let FeedContent: PlacementType
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + AtomicContent + +
        +
        +
        +
        +
        +
        +

        Placement type indicating the ad appears within atomic content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let AtomicContent: PlacementType
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + OutsideContent + +
        +
        +
        +
        +
        +
        +

        Placement type indicating the ad appears outside of content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let OutsideContent: PlacementType
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + RecommendationWidget + +
        +
        +
        +
        +
        +
        +

        Placement type indicating the ad appears within a recommendation widget.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let RecommendationWidget: PlacementType
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Custom + +
        +
        +
        +
        +
        +
        +

        Placement type for custom placements not predefined in the standard.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let Custom: PlacementType
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Prebid.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Prebid.html new file mode 100644 index 000000000..396c9eb5a --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Prebid.html @@ -0,0 +1,1589 @@ + + + + Prebid Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Prebid

      +
      +
      + + 
      @objcMembers
+public class Prebid : NSObject
      + +
      +
      +

      The Prebid class manages the configuration and initialization of the PrebidMobile SDK.

      + +
      +
      +
      +
      + + +
      + +

      Public Properties (SDK) +

      +
      +
      +
        +
      • +
        + + + + bidderNameAppNexus + +
        +
        +
        +
        +
        +
        +

        The name of the bidder for AppNexus.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let bidderNameAppNexus: String
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        The name of the bidder for Rubicon Project.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let bidderNameRubiconProject: String
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + timeoutUpdated + +
        +
        +
        +
        +
        +
        +

        Indicates whether the timeout value has been updated.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var timeoutUpdated: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidServerAccountId + +
        +
        +
        +
        +
        +
        +

        The Prebid Server account ID.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var prebidServerAccountId: String
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + pbsDebug + +
        +
        +
        +
        +
        +
        +

        Enables or disables debug mode. +ORTB: bidRequest.test

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var pbsDebug: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + customHeaders + +
        +
        +
        +
        +
        +
        +

        Custom HTTP headers to be sent with requests.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var customHeaders: [String : String]
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + storedBidResponses + +
        +
        +
        +
        +
        +
        +

        Stored bid responses identified by bidder names.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var storedBidResponses: [String : String]
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This property is set by the developer when he is willing to assign the assetID for Native ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var shouldAssignNativeAssetID: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + shareGeoLocation + +
        +
        +
        +
        +
        +
        +

        This property is set by the developer when he is willing to share the location for better ad targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var shareGeoLocation: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + logLevel + +
        +
        +
        +
        +
        +
        +

        Set the desidered verbosity of the logs

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var logLevel: LogLevel { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + externalUserIdArray + +
        +
        +
        +
        +
        +
        +

        Array containing objects that hold External UserId parameters.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var externalUserIdArray: [ExternalUserId]
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + shared + +
        +
        +
        +
        +
        +
        +

        The singleton instance of the Prebid class.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static let shared: Prebid
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + version + +
        +
        +
        +
        +
        +
        +

        The version of the PrebidMobile SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var version: String { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + omsdkVersion + +
        +
        +
        +
        +
        +
        +

        The version of the OM SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var omsdkVersion: String { get }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Public Properties (Prebid) +

      +
      +
      +
        +
      • +
        + + + + prebidServerHost + +
        +
        +
        +
        +
        +
        +

        The host for the Prebid Server.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var prebidServerHost: PrebidHost { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + customStatusEndpoint + +
        +
        +
        +
        +
        +
        +

        Custom status endpoint for the Prebid Server.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var customStatusEndpoint: String? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + timeoutMillis + +
        +
        +
        +
        +
        +
        +

        Timeout for Prebid requests in milliseconds.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var timeoutMillis: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + timeoutMillisDynamic + +
        +
        +
        +
        +
        +
        +

        Dynamic timeout value.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var timeoutMillisDynamic: NSNumber?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + storedAuctionResponse + +
        +
        +
        +
        +
        +
        +

        Stored auction response.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var storedAuctionResponse: String?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Public Properties (SDK) +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Indicates whether the PBS should cache the bid for the rendering API. +If the value is true the SDK will make the cache request in order to report +the impression event respectively to the legacy analytic setup.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var useCacheForReportingWithRenderingAPI: Bool
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Controls how long each creative has to load before it is considered a failure.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var creativeFactoryTimeout: TimeInterval
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Controls how long video and interstitial creatives have to load before it is considered a failure.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var creativeFactoryTimeoutPreRenderContent: TimeInterval
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Controls whether to use PrebidMobile’s in-app browser or the Safari App for displaying ad clickthrough content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var useExternalClickthroughBrowser: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + impClickbrowserType + +
        +
        +
        +
        +
        +
        +

        Indicates the type of browser opened upon clicking the creative in an app, where embedded = 0, native = 1. +Describes an OpenRTB imp.clickbrowser attribute.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var impClickbrowserType: ClickbrowserType
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + debugLogFileEnabled + +
        +
        +
        +
        +
        +
        +

        If set to true, the output of PrebidMobile’s internal logger is written to a text file. This can be helpful for debugging. Defaults to false.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var debugLogFileEnabled: Bool { get set }
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        If true, the SDK will periodically try to listen for location updates in order to request location-based ads.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var locationUpdatesEnabled: Bool { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + includeWinners + +
        +
        +
        +
        +
        +
        +

        If true, the sdk will add includewinners flag inside the targeting object described in PBS Documentation

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var includeWinners: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + includeBidderKeys + +
        +
        +
        +
        +
        +
        +

        If true, the sdk will add includebidderkeys flag inside the targeting object described in PBS Documentation

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var includeBidderKeys: Bool
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Public Methods +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Sets a custom Prebid Server URL.

        +
        +

        Throws

        + An error if setting the custom host URL fails. + +
        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setCustomPrebidServer(url: String) throws
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + url + + +
        +

        The custom Prebid Server URL.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Stored Bid Response +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Adds a stored bid response.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addStoredBidResponse(bidder: String, responseId: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + bidder + + +
        +

        The name of the bidder.

        +
        +
        + + responseId + + +
        +

        The response ID.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Clears all stored bid responses.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearStoredBidResponses()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Retrieves stored bid responses.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getStoredBidResponses() -> [[String : String]]?
        + +
        +
        +
        +

        Return Value

        +

        An array of dictionaries containing stored bid responses, or nil if there are none.

        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Custom Headers +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Adds a custom HTTP header.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addCustomHeader(name: String, value: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + name + + +
        +

        The name of the header.

        +
        +
        + + value + + +
        +

        The value of the header.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearCustomHeaders() + +
        +
        +
        +
        +
        +
        +

        Clears all custom HTTP headers.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearCustomHeaders()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + initializeSDK(_:_:) + +
        +
        +
        +
        +
        +
        +

        Initializes PrebidMobile SDK.

        + +

        Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. +If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. +The host value is obtained from Prebid.shared.prebidServerHost.

        + +

        Checks the version of GMA SDK. If the version is not supported - logs warning.

        + +

        Use this SDK initializer if you’re using PrebidMobile with GMA SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static func initializeSDK(_ gadMobileAdsObject: AnyObject? = nil, _ completion: PrebidInitializationCallback? = nil)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + gadMobileAdsObject + + +
        +

        GADMobileAds object

        +
        +
        + + completion + + +
        +

        returns initialization status and optional error

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Initializes PrebidMobile SDK.

        + +

        Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. +If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. +The host value is obtained from Prebid.shared.prebidServerHost.

        + +

        Checks the version of GMA SDK. If the version is not supported - logs warning.

        + +

        Use this SDK initializer if you’re using PrebidMobile with GMA SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static func initializeSDK(gadMobileAdsVersion: String? = nil, _ completion: PrebidInitializationCallback? = nil)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + gadMobileAdsVersion + + +
        +

        GADMobileAds version string, use GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber) to get it

        +
        +
        + + completion + + +
        +

        returns initialization status and optional error

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + initializeSDK(_:) + +
        +
        +
        +
        +
        +
        +

        Initializes PrebidMobile SDK.

        + +

        Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. +If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. +The host value is obtained from Prebid.shared.prebidServerHost.

        + +

        Use this SDK initializer if you’re using PrebidMobile without GMA SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static func initializeSDK(_ completion: PrebidInitializationCallback? = nil)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + completion + + +
        +

        returns initialization status and optional error

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PrebidAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PrebidAdUnit.html new file mode 100644 index 000000000..53537e0c0 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PrebidAdUnit.html @@ -0,0 +1,634 @@ + + + + PrebidAdUnit Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PrebidAdUnit

      +
      +
      + + 
      @objcMembers
+public class PrebidAdUnit : NSObject
      + +
      +
      +

      Multiformat ad unit. Built for original API.

      + +
      +
      +
      +
        +
      • +
        + + + + pbAdSlot + +
        +
        +
        +
        +
        +
        +

        The ad slot identifier for the Prebid ad unit.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var pbAdSlot: String? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(configId:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new PrebidAdUnit with the given configuration ID.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(configId: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Makes bid request for the specified ad object and request config. Setups targeting keywords into the adObject.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func fetchDemand(adObject: AnyObject, request: PrebidRequest,
+                        completion: @escaping (BidInfo) -> Void)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + + + + + +
        + + adObject + + +
        +

        The ad object to fetch demand for.

        +
        +
        + + request + + +
        +

        The PrebidRequest containing the demand request parameters.

        +
        +
        + + completion + + +
        +

        A closure to be called with the BidInfo result.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Makes bid request for the specified request config.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func fetchDemand(request: PrebidRequest, completion: @escaping (BidInfo) -> Void)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + request + + +
        +

        The PrebidRequest containing the demand request parameters.

        +
        +
        + + completion + + +
        +

        A closure to be called with the BidInfo result.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Auto refresh API +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        This method allows to set the auto refresh period for the demand

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setAutoRefreshMillis(time: Double)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + time + + +
        +

        refresh time interval

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + stopAutoRefresh() + +
        +
        +
        +
        +
        +
        +

        This method stops the auto refresh of demand

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func stopAutoRefresh()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + resumeAutoRefresh() + +
        +
        +
        +
        +
        +
        +

        This method resumes the auto refresh of demand

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func resumeAutoRefresh()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PrebidRequest.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PrebidRequest.html new file mode 100644 index 000000000..dcecea00c --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/PrebidRequest.html @@ -0,0 +1,1065 @@ + + + + PrebidRequest Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PrebidRequest

      +
      +
      + + 
      @objcMembers
+public class PrebidRequest : NSObject
      + +
      +
      +

      Class that contains properties and methods to configure Prebid request.

      + +
      +
      +
      +
      + + +
      + +

      Private properties +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Initializes a new PrebidRequest with the given parameters.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(bannerParameters: BannerParameters? = nil, videoParameters: VideoParameters? = nil,
+            nativeParameters: NativeParameters? = nil, isInterstitial: Bool = false, isRewarded: Bool = false)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + + + + + + + + + + + + + +
        + + bannerParameters + + +
        +

        The banner parameters for the ad request.

        +
        +
        + + videoParameters + + +
        +

        The video parameters for the ad request.

        +
        +
        + + nativeParameters + + +
        +

        The native parameters for the ad request.

        +
        +
        + + isInterstitial + + +
        +

        Indicates if the request is for an interstitial ad.

        +
        +
        + + isRewarded + + +
        +

        Indicates if the request is for a rewarded ad.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      GPID +

      +
      +
      +
        +
      • +
        + + + + setGPID(_:) + +
        +
        +
        +
        +
        +
        +

        Sets the GPID for the ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setGPID(_ gpid: String?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + gpid + + +
        +

        The GPID to set.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      adunit ext data aka inventory data (imp[].ext.data) +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        This method obtains the ext data keyword & value for adunit targeting +if the key already exists the value will be appended to the list. No duplicates will be added

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addExtData(key: String, value: String)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method obtains the ext data keyword & values for adunit targeting +the values if the key already exist will be replaced with the new set of values

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func updateExtData(key: String, value: Set<String>)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method allows to remove specific ext data keyword & values set from adunit targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeExtData(forKey: String)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + clearExtData() + +
        +
        +
        +
        +
        +
        +

        This method allows to remove all ext data set from adunit targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearExtData()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      adunit ext keywords (imp[].ext.keywords) +

      +
      +
      +
        +
      • +
        + + + + addExtKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        This method obtains the keyword for adunit targeting +Inserts the given element in the set if it is not already present.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addExtKeyword(_ newElement: String)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + addExtKeywords(_:) + +
        +
        +
        +
        +
        +
        +

        This method obtains the keyword set for adunit targeting +Adds the elements of the given set to the set.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addExtKeywords(_ newElements: Set<String>)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + removeExtKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        This method allows to remove specific keyword from adunit targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeExtKeyword(_ element: String)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + clearExtKeywords() + +
        +
        +
        +
        +
        +
        +

        This method allows to remove all keywords from the set of adunit targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearExtKeywords()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      App Content (app.content.data) +

      +
      +
      +
        +
      • +
        + + + + setAppContent(_:) + +
        +
        +
        +
        +
        +
        +

        Sets the app content for the ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setAppContent(_ appContentObject: PBMORTBAppContent)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + appContentObject + + +
        +

        The PBMORTBAppContent to set.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearAppContent() + +
        +
        +
        +
        +
        +
        +

        Clears the app content for the ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearAppContent()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + addAppContentData(_:) + +
        +
        +
        +
        +
        +
        +

        Adds data to the app content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addAppContentData(_ dataObjects: [PBMORTBContentData])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + dataObjects + + +
        +

        The array of PBMORTBContentData to add.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Removes specific data from the app content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeAppContentData(_ dataObject: PBMORTBContentData)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + dataObject + + +
        +

        The PBMORTBContentData to remove.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearAppContentData() + +
        +
        +
        +
        +
        +
        +

        Clears all data from the app content.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearAppContentData()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      User Data (user.data) +

      +
      +
      +
        +
      • +
        + + + + addUserData(_:) + +
        +
        +
        +
        +
        +
        +

        Adds user data to the ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addUserData(_ userDataObjects: [PBMORTBContentData])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + userDataObjects + + +
        +

        The array of PBMORTBContentData to add.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + removeUserData(_:) + +
        +
        +
        +
        +
        +
        +

        Removes specific user data from the ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeUserData(_ userDataObject: PBMORTBContentData)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + userDataObject + + +
        +

        The PBMORTBContentData to remove.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearUserData() + +
        +
        +
        +
        +
        +
        +

        Clears all user data from the ad request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearUserData()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/RewardedAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/RewardedAdUnit.html new file mode 100644 index 000000000..df5bbba2e --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/RewardedAdUnit.html @@ -0,0 +1,1001 @@ + + + + RewardedAdUnit Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      RewardedAdUnit

      +
      +
      + + 
      @objc
+public class RewardedAdUnit: BaseInterstitialAdUnit,
+                             RewardedEventInteractionDelegate
      + +
      +
      +

      Represents an rewarded ad unit. Built for rendering type of integration.

      + +
      +
      +
      +
        +
      • +
        + + + + reward + +
        +
        +
        +
        +
        +
        +

        The reward object for the ad unit.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public private(set) var reward: NSObject? { get }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Lifecycle +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Initializes a RewardedAdUnit with the given configuration ID and event handler.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public convenience init(configID: String, eventHandler: AnyObject)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + configID + + +
        +

        The configuration ID for the ad unit.

        +
        +
        + + eventHandler + + +
        +

        The event handler for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + init(configID:) + +
        +
        +
        +
        +
        +
        +

        Initializes a RewardedAdUnit with the given configuration ID and a default event handler.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public convenience init(configID: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + configID + + +
        +

        The configuration ID for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      PBMRewardedEventDelegate +

      +
      +
      +
        +
      • +
        + + + + userDidEarnReward(_:) + +
        +
        +
        +
        +
        +
        +

        Called when the user earns a reward.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func userDidEarnReward(_ reward: NSObject?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + reward + + +
        +

        The reward object associated with the event.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      BaseInterstitialAdUnitProtocol protocol +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Called when the interstitial ad is closed.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func interstitialControllerDidCloseAd(_ interstitialController: InterstitialController)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + interstitialController + + +
        +

        The controller managing the interstitial ad.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Protected overrides +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Called when the ad unit receives an ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callDelegate_didReceiveAd()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the ad unit fails to receive an ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callDelegate_didFailToReceiveAd(with error: Error?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + error + + +
        +

        The error describing the failure.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the ad unit will present an ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callDelegate_willPresentAd()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the ad unit dismisses an ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callDelegate_didDismissAd()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the ad unit will leave the application.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callDelegate_willLeaveApplication()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the ad unit is clicked.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callDelegate_didClickAd()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Returns whether the event handler is ready.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callEventHandler_isReady() -> Bool
        + +
        +
        +
        +

        Return Value

        +

        A boolean indicating if the event handler is ready.

        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Sets the loading delegate for the event handler.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callEventHandler_setLoadingDelegate(_ loadingDelegate: NSObject?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + loadingDelegate + + +
        +

        The loading delegate to set.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Sets the interaction delegate for the event handler.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callEventHandler_setInteractionDelegate()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Requests an ad with the given bid response.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callEventHandler_requestAd(with bidResponse: BidResponse?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + bidResponse + + +
        +

        The bid response to use for the ad request.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Shows the ad from the specified view controller.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callEventHandler_show(from controller: UIViewController?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + controller + + +
        +

        The view controller from which to present the ad.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Tracks the impression for the ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public override func callEventHandler_trackImpression()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/RewardedVideoAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/RewardedVideoAdUnit.html new file mode 100644 index 000000000..f50083c92 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/RewardedVideoAdUnit.html @@ -0,0 +1,494 @@ + + + + RewardedVideoAdUnit Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      RewardedVideoAdUnit

      +
      +
      + + 
      public class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
      + +
      +
      +

      Represents an rewarded ad unit for original type of integration.

      + +
      +
      +
      +
        +
      • +
        + + + + parameters + +
        +
        +
        +
        +
        +
        +

        Deprecated property for video parameters.

        +
        +

        Note

        + This property is deprecated. Please use videoParameters instead. + +
        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This property is deprecated. Please, use videoParameters instead.")
+public var parameters: VideoParameters { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + videoParameters + +
        +
        +
        +
        +
        +
        +

        Property for video parameters.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var videoParameters: VideoParameters { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(configId:) + +
        +
        +
        +
        +
        +
        +

        Initializes a RewardedVideoAdUnit with the given configuration ID.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(configId: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Initializes a RewardedVideoAdUnit with the given configuration ID and minimum size percentages.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public convenience init(configId: String, minWidthPerc: Int, minHeightPerc: Int)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        + + minWidthPerc + + +
        +

        The minimum width percentage for the ad unit.

        +
        +
        + + minHeightPerc + + +
        +

        The minimum height percentage for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals.html new file mode 100644 index 000000000..c959c3000 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals.html @@ -0,0 +1,514 @@ + + + + Signals Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Signals

      +
      +
      + + 
      public class Signals : NSObject
      + +
      +
      +

      A class containing constants related to OpenRTB signals.

      + +

      This class provides static constants and values representing different +API frameworks, playback methods, protocols, start delays, and video +placement types as defined in the OpenRTB specification.

      + +
      +
      +
      +
        +
      • +
        + + + + Api + +
        +
        +
        +
        +
        +
        +

        OpenRTB - API Frameworks

        +
         | Value | Description |
+ |-------|-------------|
+ | 1     | VPAID 1.0   |
+ | 2     | VPAID 2.0   |
+ | 3     | MRAID-1     |
+ | 4     | ORMMA       |
+ | 5     | MRAID-2     |
+ | 6     | MRAID-3     |
+ | 7     | OMID-1      |
+
        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBApi)
+public class Api : SingleContainerInt
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + PlaybackMethod + +
        +
        +
        +
        +
        +
        +

        OpenRTB - Playback Methods

        +
        | Value | Description                                              |
+|-------|----------------------------------------------------------|
+| 1     | Initiates on Page Load with Sound On                     |
+| 2     | Initiates on Page Load with Sound Off by Default         |
+| 3     | Initiates on Click with Sound On                         |
+| 4     | Initiates on Mouse-Over with Sound On                    |
+| 5     | Initiates on Entering Viewport with Sound On             |
+| 6     | Initiates on Entering Viewport with Sound Off by Default |
+
        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBPlaybackMethod)
+public class PlaybackMethod : SingleContainerInt
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Protocols + +
        +
        +
        +
        +
        +
        +

        OpenRTB - Protocols

        +
        | Value | Description       |
+|-------|-------------------|
+| 1     | VAST 1.0          |
+| 2     | VAST 2.0          |
+| 3     | VAST 3.0          |
+| 4     | VAST 1.0 Wrapper  |
+| 5     | VAST 2.0 Wrapper  |
+| 6     | VAST 3.0 Wrapper  |
+| 7     | VAST 4.0          |
+| 8     | VAST 4.0 Wrapper  |
+| 9     | DAAST 1.0         |
+| 10    | DAAST 1.0 Wrapper |
+
        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBProtocols)
+public class Protocols : SingleContainerInt
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + StartDelay + +
        +
        +
        +
        +
        +
        +

        OpenRTB - Start Delay

        +
        | Value | Description                                      |
+|-------|--------------------------------------------------|
+| > 0   | Mid-Roll (value indicates start delay in second) |
+| 0     | Pre-Roll                                         |
+| -1    | Generic Mid-Roll                                 |
+| -2    | Generic Post-Roll                                |
+
        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBStartDelay)
+public class StartDelay : SingleContainerInt
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Placement + +
        +
        +
        +
        +
        +
        +

        OpenRTB - Video Placement Types

        +
        | Value | Description                  |
+|-------|------------------------------|
+| 1     | In-Stream                    |
+| 2     | In-Banner                    |
+| 3     | In-Article                   |
+| 4     | In-Feed                      |
+| 5     | Interstitial/Slider/Floating |
+
        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBPlacement)
+public class Placement : SingleContainerInt
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Api.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Api.html new file mode 100644 index 000000000..caaa75f78 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Api.html @@ -0,0 +1,527 @@ + + + + Api Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Api

      +
      +
      + + 
      @objc(PBApi)
+public class Api : SingleContainerInt
      + +
      +
      +

      OpenRTB - API Frameworks

      +
       | Value | Description |
+ |-------|-------------|
+ | 1     | VPAID 1.0   |
+ | 2     | VPAID 2.0   |
+ | 3     | MRAID-1     |
+ | 4     | ORMMA       |
+ | 5     | MRAID-2     |
+ | 6     | MRAID-3     |
+ | 7     | OMID-1      |
+
      + +
      +
      +
      +
        +
      • +
        + + + + VPAID_1 + +
        +
        +
        +
        +
        +
        +

        VPAID 1.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VPAID_1: Signals.Api
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VPAID_2 + +
        +
        +
        +
        +
        +
        +

        VPAID 2.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VPAID_2: Signals.Api
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + MRAID_1 + +
        +
        +
        +
        +
        +
        +

        MRAID-1

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let MRAID_1: Signals.Api
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ORMMA + +
        +
        +
        +
        +
        +
        +

        ORMMA

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let ORMMA: Signals.Api
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + MRAID_2 + +
        +
        +
        +
        +
        +
        +

        MRAID-2

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let MRAID_2: Signals.Api
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + MRAID_3 + +
        +
        +
        +
        +
        +
        +

        MRAID-3

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let MRAID_3: Signals.Api
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + OMID_1 + +
        +
        +
        +
        +
        +
        +

        OMID-1

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let OMID_1: Signals.Api
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Placement.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Placement.html new file mode 100644 index 000000000..94e8b4dfe --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Placement.html @@ -0,0 +1,553 @@ + + + + Placement Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Placement

      +
      +
      + + 
      @objc(PBPlacement)
+public class Placement : SingleContainerInt
      + +
      +
      +

      OpenRTB - Video Placement Types

      +
      | Value | Description                  |
+|-------|------------------------------|
+| 1     | In-Stream                    |
+| 2     | In-Banner                    |
+| 3     | In-Article                   |
+| 4     | In-Feed                      |
+| 5     | Interstitial/Slider/Floating |
+
      + +
      +
      +
      +
        +
      • +
        + + + + InStream + +
        +
        +
        +
        +
        +
        +

        In-Stream

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let InStream: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + InBanner + +
        +
        +
        +
        +
        +
        +

        In-Banner

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let InBanner: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + InArticle + +
        +
        +
        +
        +
        +
        +

        In-Article

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let InArticle: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + InFeed + +
        +
        +
        +
        +
        +
        +

        In-Feed

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let InFeed: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Interstitial + +
        +
        +
        +
        +
        +
        +

        Interstitial

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let Interstitial: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Slider + +
        +
        +
        +
        +
        +
        +

        Slider

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let Slider: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Floating + +
        +
        +
        +
        +
        +
        +

        Floating

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let Floating: Signals.Placement
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Helper function

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static func getPlacementByRawValue(_ value: Int) -> Signals.Placement?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/PlaybackMethod.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/PlaybackMethod.html new file mode 100644 index 000000000..aee7a98a2 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/PlaybackMethod.html @@ -0,0 +1,498 @@ + + + + PlaybackMethod Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PlaybackMethod

      +
      +
      + + 
      @objc(PBPlaybackMethod)
+public class PlaybackMethod : SingleContainerInt
      + +
      +
      +

      OpenRTB - Playback Methods

      +
      | Value | Description                                              |
+|-------|----------------------------------------------------------|
+| 1     | Initiates on Page Load with Sound On                     |
+| 2     | Initiates on Page Load with Sound Off by Default         |
+| 3     | Initiates on Click with Sound On                         |
+| 4     | Initiates on Mouse-Over with Sound On                    |
+| 5     | Initiates on Entering Viewport with Sound On             |
+| 6     | Initiates on Entering Viewport with Sound Off by Default |
+
      + +
      +
      +
      +
        +
      • +
        + + + + AutoPlaySoundOn + +
        +
        +
        +
        +
        +
        +

        Initiates on Page Load with Sound On

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let AutoPlaySoundOn: Signals.PlaybackMethod
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + AutoPlaySoundOff + +
        +
        +
        +
        +
        +
        +

        Initiates on Page Load with Sound Off by Default

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let AutoPlaySoundOff: Signals.PlaybackMethod
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ClickToPlay + +
        +
        +
        +
        +
        +
        +

        Initiates on Click with Sound On

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let ClickToPlay: Signals.PlaybackMethod
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + MouseOver + +
        +
        +
        +
        +
        +
        +

        Initiates on Mouse-Over with Sound On

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let MouseOver: Signals.PlaybackMethod
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + EnterSoundOn + +
        +
        +
        +
        +
        +
        +

        Initiates on Entering Viewport with Sound On

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let EnterSoundOn: Signals.PlaybackMethod
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + EnterSoundOff + +
        +
        +
        +
        +
        +
        +

        Initiates on Entering Viewport with Sound Off by Default

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let EnterSoundOff: Signals.PlaybackMethod
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Protocols.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Protocols.html new file mode 100644 index 000000000..05f332c5d --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/Protocols.html @@ -0,0 +1,614 @@ + + + + Protocols Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Protocols

      +
      +
      + + 
      @objc(PBProtocols)
+public class Protocols : SingleContainerInt
      + +
      +
      +

      OpenRTB - Protocols

      +
      | Value | Description       |
+|-------|-------------------|
+| 1     | VAST 1.0          |
+| 2     | VAST 2.0          |
+| 3     | VAST 3.0          |
+| 4     | VAST 1.0 Wrapper  |
+| 5     | VAST 2.0 Wrapper  |
+| 6     | VAST 3.0 Wrapper  |
+| 7     | VAST 4.0          |
+| 8     | VAST 4.0 Wrapper  |
+| 9     | DAAST 1.0         |
+| 10    | DAAST 1.0 Wrapper |
+
      + +
      +
      +
      +
        +
      • +
        + + + + VAST_1_0 + +
        +
        +
        +
        +
        +
        +

        VAST 1.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_1_0: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_2_0 + +
        +
        +
        +
        +
        +
        +

        VAST 2.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_2_0: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_3_0 + +
        +
        +
        +
        +
        +
        +

        VAST 3.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_3_0: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_1_0_Wrapper + +
        +
        +
        +
        +
        +
        +

        VAST 1.0 Wrapper

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_1_0_Wrapper: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_2_0_Wrapper + +
        +
        +
        +
        +
        +
        +

        VAST 2.0 Wrapper

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_2_0_Wrapper: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_3_0_Wrapper + +
        +
        +
        +
        +
        +
        +

        VAST 3.0 Wrapper

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_3_0_Wrapper: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_4_0 + +
        +
        +
        +
        +
        +
        +

        VAST 4.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_4_0: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + VAST_4_0_Wrapper + +
        +
        +
        +
        +
        +
        +

        VAST 4.0 Wrapper

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let VAST_4_0_Wrapper: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + DAAST_1_0 + +
        +
        +
        +
        +
        +
        +

        DAAST 1.0

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let DAAST_1_0: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + DAAST_1_0_WRAPPER + +
        +
        +
        +
        +
        +
        +

        DAAST 1.0 Wrapper

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let DAAST_1_0_WRAPPER: Signals.Protocols
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/StartDelay.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/StartDelay.html new file mode 100644 index 000000000..f781fe6ea --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Signals/StartDelay.html @@ -0,0 +1,412 @@ + + + + StartDelay Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      StartDelay

      +
      +
      + + 
      @objc(PBStartDelay)
+public class StartDelay : SingleContainerInt
      + +
      +
      +

      OpenRTB - Start Delay

      +
      | Value | Description                                      |
+|-------|--------------------------------------------------|
+| > 0   | Mid-Roll (value indicates start delay in second) |
+| 0     | Pre-Roll                                         |
+| -1    | Generic Mid-Roll                                 |
+| -2    | Generic Post-Roll                                |
+
      + +
      +
      +
      +
        +
      • +
        + + + + PreRoll + +
        +
        +
        +
        +
        +
        +

        Pre-Roll

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let PreRoll: Signals.StartDelay
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + GenericMidRoll + +
        +
        +
        +
        +
        +
        +

        Generic Mid-Roll

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let GenericMidRoll: Signals.StartDelay
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + GenericPostRoll + +
        +
        +
        +
        +
        +
        +

        Generic Post-Roll

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let GenericPostRoll: Signals.StartDelay
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/SingleContainerInt.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/SingleContainerInt.html new file mode 100644 index 000000000..0b6a2bf60 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/SingleContainerInt.html @@ -0,0 +1,453 @@ + + + + SingleContainerInt Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      SingleContainerInt

      +
      +
      + + 
      public class SingleContainerInt : NSObject, ExpressibleByIntegerLiteral
      + +
      +
      +

      Undocumented

      + +
      +
      +
      +
        +
      • +
        + + + + IntegerLiteralType + +
        +
        +
        +
        +
        +
        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public typealias IntegerLiteralType = Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + value + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public let value: Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(integerLiteral:) + +
        +
        +
        +
        +
        +
        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public required init(integerLiteral value: Int)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + isEqual(_:) + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        override public func isEqual(_ object: Any?) -> Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + hash + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        override public var hash: Int { get }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Targeting.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Targeting.html new file mode 100644 index 000000000..cfbf2e935 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Targeting.html @@ -0,0 +1,3326 @@ + + + + Targeting Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Targeting

      +
      +
      + + 
      @objcMembers
+public class Targeting : NSObject
      + +
      +
      +

      A class that manages targeting information for ads.

      + +

      This class provides properties and methods for setting and retrieving +user-specific targeting information, such as user ID, gender, and custom +data. It also includes details for OMID (Open Measurement Interface Definition) +partner and supports managing user identity links and custom extensions.

      + +
      +
      +
      +
        +
      • +
        + + + + shared + +
        +
        +
        +
        +
        +
        +

        A shared instance of the Targeting class.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static var shared: Targeting
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      OMID Partner +

      +
      +
      +
        +
      • +
        + + + + omidPartnerName + +
        +
        +
        +
        +
        +
        +

        The name of the OMID partner.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var omidPartnerName: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + omidPartnerVersion + +
        +
        +
        +
        +
        +
        +

        The version of the OMID partner.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var omidPartnerVersion: String?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      User Information +

      +
      +
      +
        +
      • +
        + + + + yearOfBirth + +
        +
        +
        +
        +
        +
        +

        Indicates user birth year.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var yearOfBirth: Int { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + setYearOfBirth(yob:) + +
        +
        +
        +
        +
        +
        +

        This method set the year of birth value

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setYearOfBirth(yob: Int)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getYearOfBirth() + +
        +
        +
        +
        +
        +
        +

        Objective C API

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getYearOfBirth() -> NSNumber
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + clearYearOfBirth() + +
        +
        +
        +
        +
        +
        +

        This method clears year of birth value set by the application developer

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearYearOfBirth()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + userGender + +
        +
        +
        +
        +
        +
        +

        Indicates the end-user’s gender.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var userGender: Gender { get set }
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        String representation of the users gender, +where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown)

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func userGenderDescription() -> String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + userID + +
        +
        +
        +
        +
        +
        +

        Indicates the customer-provided user ID, if different from the Device ID.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var userID: String? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + buyerUID + +
        +
        +
        +
        +
        +
        +

        Buyer-specific ID for the user as mapped by the exchange for the buyer.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var buyerUID: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + userCustomData + +
        +
        +
        +
        +
        +
        +

        Optional feature to pass bidder data that was set in the +exchange’s cookie. The string must be in base85 cookie safe +characters and be in any format. Proper JSON encoding must +be used to include “escaped” quotation marks.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var userCustomData: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + eids + +
        +
        +
        +
        +
        +
        +

        Placeholder for User Identity Links. +The data from this property will be added to usr.ext.eids

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var eids: [[String : AnyHashable]]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + userExt + +
        +
        +
        +
        +
        +
        +

        Placeholder for exchange-specific extensions to OpenRTB.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var userExt: [String : AnyHashable]?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      COPPA +

      +
      +
      +
        +
      • +
        + + + + coppa + +
        +
        +
        +
        +
        +
        +

        Objective C analog of subjectToCOPPA

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var coppa: NSNumber? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + subjectToCOPPA + +
        +
        +
        +
        +
        +
        +

        Integer flag indicating if this request is subject to the COPPA regulations +established by the USA FTC, where 0 = no, 1 = yes

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var subjectToCOPPA: Bool? { get set }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      GDPR +

      +
      +
      +
        +
      • +
        + + + + subjectToGDPR + +
        +
        +
        +
        +
        +
        +

        The boolean value set by the user to collect user data

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var subjectToGDPR: Bool? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + setSubjectToGDPR(_:) + +
        +
        +
        +
        +
        +
        +

        Objective-C API

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setSubjectToGDPR(_ newValue: NSNumber?)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getSubjectToGDPR() + +
        +
        +
        +
        +
        +
        +

        Objective-C API

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getSubjectToGDPR() -> NSNumber?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      GDPR Consent +

      +
      +
      +
        +
      • +
        + + + + gdprConsentString + +
        +
        +
        +
        +
        +
        +

        The consent string for sending the GDPR consent

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var gdprConsentString: String? { get set }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      TCFv2 +

      +
      +
      +
        +
      • +
        + + + + purposeConsents + +
        +
        +
        +
        +
        +
        +

        The consent string for purposes consent as per TCFv2.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var purposeConsents: String? { get set }
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Purpose 1 - Store and/or access information on a device

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getDeviceAccessConsent() -> Bool?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Returns whether the user has consented to access device data as an NSNumber.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getDeviceAccessConsentObjc() -> NSNumber?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Returns the user’s consent for a specific purpose by index.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getPurposeConsent(index: Int) -> Bool?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Checks if access to device data is allowed.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func isAllowedAccessDeviceData() -> Bool
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      External User Ids +

      +
      +
      +
        +
      • +
        + + + + externalUserIds + +
        +
        +
        +
        +
        +
        +

        Array of external user IDs.

        + +

        This property holds the external user IDs associated with the user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var externalUserIds: [ExternalUserId]
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method allows to save External User Id in the User Defaults

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func storeExternalUserId(_ externalUserId: ExternalUserId)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method allows to get All External User Ids from User Defaults

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func fetchStoredExternalUserIds() -> [ExternalUserId]?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method allows to get External User Id from User Defaults by passing respective ‘source’ string as param

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func fetchStoredExternalUserId(_ source: String) -> ExternalUserId?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method allows to remove specific External User Id from User Defaults by passing respective ‘source’ string as param

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeStoredExternalUserId(_ source: String)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This method allows to remove all the External User Ids from User Defaults

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeStoredExternalUserIds()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getExternalUserIds() + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getExternalUserIds() -> [[AnyHashable : Any]]?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Application Information +

      +
      +
      +
        +
      • +
        + + + + contentUrl + +
        +
        +
        +
        +
        +
        +

        This is the deep-link URL for the app screen that is displaying the ad. This can be an iOS universal link.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var contentUrl: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + publisherName + +
        +
        +
        +
        +
        +
        +

        App’s publisher name.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var publisherName: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + sourceapp + +
        +
        +
        +
        +
        +
        +

        ID of publisher app in Apple’s App Store.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var sourceapp: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + storeURL + +
        +
        +
        +
        +
        +
        +

        App store URL for an installed app

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var storeURL: String? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + domain + +
        +
        +
        +
        +
        +
        +

        Domain name of the app

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var domain: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + itunesID + +
        +
        +
        +
        +
        +
        +

        The itunes app id for targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var itunesID: String?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + location + +
        +
        +
        +
        +
        +
        +

        The application location for targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var location: CLLocation?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + locationPrecision + +
        +
        +
        +
        +
        +
        +

        The application location precision for targeting

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var locationPrecision: Int?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Objective-C API

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setLocationPrecision(_ newValue: NSNumber?)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Objective-C API

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getLocationPrecision() -> NSNumber?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Location and connection information +

      +
      +
      +
        +
      • +
        + + + + coordinate + +
        +
        +
        +
        +
        +
        +

        CLLocationCoordinate2D. +See CoreLocation framework documentation.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var coordinate: NSValue?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Public Methods +

      +
      +
      +
        +
      • +
        + + + + addParam(_:withName:) + +
        +
        +
        +
        +
        +
        +

        Adds a parameter to the parameter dictionary with a specified name.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addParam(_ value: String, withName: String?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + value + + +
        +

        The value of the parameter.

        +
        +
        + + withName + + +
        +

        The name of the parameter. If nil, the parameter is not added.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + setCustomParams(_:) + +
        +
        +
        +
        +
        +
        +

        Sets custom parameters by adding each key-value pair to the parameter dictionary.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setCustomParams(_ params: [String : String]?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + params + + +
        +

        A dictionary of parameters to set. If nil, no parameters are added.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Adds a custom parameter to the parameter dictionary with a prefixed name.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addCustomParam(_ value: String, withName: String?)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + value + + +
        +

        The value of the custom parameter.

        +
        +
        + + withName + + +
        +

        The name of the custom parameter. If nil, the parameter is not added.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Store location in the user’s section

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setLatitude(_ latitude: Double, longitude: Double)
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Access Control List (ext.prebid.data) +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Adds a bidder to the access control list.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addBidderToAccessControlList(_ bidderName: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + bidderName + + +
        +

        The name of the bidder to add.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Removes a bidder from the access control list.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeBidderFromAccessControlList(_ bidderName: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + bidderName + + +
        +

        The name of the bidder to remove.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Clears all bidders from the access control list.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearAccessControlList()
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Retrieves the current access control list.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getAccessControlList() -> [String]
        + +
        +
        +
        +

        Return Value

        +

        An array of bidder names in the access control list.

        +
        +
        +
        +
        • +
      • +
        + + + + accessControlList + +
        +
        +
        +
        +
        +
        +

        Access control list for external use.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var accessControlList: [String] { get }
        + +
        +
        +
        +

        Return Value

        +

        An array of bidder names in the access control list.

        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Global User Data (user.ext.data) +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Adds user data for a specified key.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addUserData(key: String, value: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + key + + +
        +

        The key for the user data.

        +
        +
        + + value + + +
        +

        The value to add for the specified key.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Updates user data for a specified key with a new set of values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func updateUserData(key: String, value: Set<String>)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + key + + +
        +

        The key for the user data.

        +
        +
        + + value + + +
        +

        The set of values to update for the specified key.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + removeUserData(for:) + +
        +
        +
        +
        +
        +
        +

        Removes user data for a specified key.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeUserData(for key: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + key + + +
        +

        The key for the user data to remove.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearUserData() + +
        +
        +
        +
        +
        +
        +

        Clears all user data.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearUserData()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getUserData() + +
        +
        +
        +
        +
        +
        +

        Retrieves all user data.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getUserData() -> [String : [String]]
        + +
        +
        +
        +

        Return Value

        +

        A dictionary mapping keys to arrays of values.

        +
        +
        +
        +
        • +
      • +
        + + + + userDataDictionary + +
        +
        +
        +
        +
        +
        +

        User data dictionary for external use.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var userDataDictionary: [String : [String]] { get }
        + +
        +
        +
        +

        Return Value

        +

        A dictionary mapping keys to arrays of values.

        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Global User Keywords (user.keywords) +

      +
      +
      +
        +
      • +
        + + + + addUserKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        Adds a user keyword.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addUserKeyword(_ newElement: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + newElement + + +
        +

        The keyword to add.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + addUserKeywords(_:) + +
        +
        +
        +
        +
        +
        +

        Adds multiple user keywords.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addUserKeywords(_ newElements: Set<String>)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + newElements + + +
        +

        A set of keywords to add.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + removeUserKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        Removes a user keyword.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeUserKeyword(_ element: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + element + + +
        +

        The keyword to remove.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearUserKeywords() + +
        +
        +
        +
        +
        +
        +

        Clears all user keywords.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearUserKeywords()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getUserKeywords() + +
        +
        +
        +
        +
        +
        +

        Retrieves all user keywords.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getUserKeywords() -> [String]
        + +
        +
        +
        +

        Return Value

        +

        An array of user keywords.

        +
        +
        +
        +
        • +
      • +
        + + + + userKeywords + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use getUserKeywords method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This property is deprecated. Please, use getUserKeywords method instead.")
+public var userKeywords: [String] { get }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Global Data (app.ext.data) +

      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Deprecated. Use addAppExtData method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use addAppExtData method instead.")
+public func addContextData(key: String, value: String)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Deprecated. Use updateAppExtData method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use updateAppExtData method instead.")
+public func updateContextData(key: String, value: Set<String>)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Deprecated. Use removeAppExtData method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use removeAppExtData method instead.")
+public func removeContextData(for key: String)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + clearContextData() + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use clearAppExtData method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use clearAppExtData method instead.")
+public func clearContextData()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getContextData() + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use getAppExtData method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use getAppExtData method instead.")
+public func getContextData() -> [String : [String]]
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + contextDataDictionary + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use getAppExtData method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This property is deprecated. Please, use getAppExtData method instead.")
+public var contextDataDictionary: [String : [String]] { get }
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Adds application-specific data for a specified key.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addAppExtData(key: String, value: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + key + + +
        +

        The key for the application data.

        +
        +
        + + value + + +
        +

        The value to add for the specified key.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Updates application-specific data for a specified key with a new set of values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func updateAppExtData(key: String, value: Set<String>)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + key + + +
        +

        The key for the application data.

        +
        +
        + + value + + +
        +

        The set of values to update for the specified key.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Removes application-specific data for a specified key.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeAppExtData(for key: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + key + + +
        +

        The key for the application data to remove.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearAppExtData() + +
        +
        +
        +
        +
        +
        +

        Clears all application-specific data.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearAppExtData()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getAppExtData() + +
        +
        +
        +
        +
        +
        +

        Retrieves all application-specific data.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getAppExtData() -> [String : [String]]
        + +
        +
        +
        +

        Return Value

        +

        A dictionary mapping keys to arrays of values.

        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Global Keywords (app.keywords) +

      +
      +
      +
        +
      • +
        + + + + addContextKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use addAppKeyword method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use addAppKeyword method instead.")
+public func addContextKeyword(_ newElement: String)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Deprecated. Use addAppKeywords method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use addAppKeywords method instead.")
+public func addContextKeywords(_ newElements: Set<String>)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Deprecated. Use removeAppKeyword method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use removeAppKeyword method instead.")
+public func removeContextKeyword(_ element: String)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Deprecated. Use clearAppKeywords method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use clearAppKeywords method instead.")
+public func clearContextKeywords()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getContextKeywords() + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use getAppKeywords method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This method is deprecated. Please, use getAppKeywords method instead.")
+public func getContextKeywords() -> [String]
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + contextKeywords + +
        +
        +
        +
        +
        +
        +

        Deprecated. Use getAppKeywords method instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "This property is deprecated. Please, use getAppKeywords method instead.")
+public var contextKeywords: [String] { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + addAppKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        Adds an application keyword.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addAppKeyword(_ newElement: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + newElement + + +
        +

        The keyword to add.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + addAppKeywords(_:) + +
        +
        +
        +
        +
        +
        +

        Adds multiple application keywords.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addAppKeywords(_ newElements: Set<String>)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + newElements + + +
        +

        A set of keywords to add.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + removeAppKeyword(_:) + +
        +
        +
        +
        +
        +
        +

        Removes an application keyword.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func removeAppKeyword(_ element: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + element + + +
        +

        The keyword to remove.

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + clearAppKeywords() + +
        +
        +
        +
        +
        +
        +

        Clears all application keywords.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func clearAppKeywords()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getAppKeywords() + +
        +
        +
        +
        +
        +
        +

        Retrieves all application keywords.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func getAppKeywords() -> [String]
        + +
        +
        +
        +

        Return Value

        +

        An array of application keywords.

        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Internal Properties +

      +
      +
      +
        +
      • +
        + + + + parameterDictionary + +
        +
        +
        +
        +
        +
        +

        Dictionary of parameters.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var parameterDictionary: [String : String]
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Utils.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Utils.html new file mode 100644 index 000000000..3e3635acc --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/Utils.html @@ -0,0 +1,450 @@ + + + + Utils Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Utils

      +
      +
      + + 
      public class Utils : NSObject
      + +
      +
      +

      A utility class for handling various ad-related operations and conversions.

      + +
      +
      +
      +
        +
      • +
        + + + + shared + +
        +
        +
        +
        +
        +
        +

        The class is created as a singleton object & used

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public static let shared: Utils
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + delegate + +
        +
        +
        +
        +
        +
        +

        A delegate to handle native ad events.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public weak var delegate: NativeAdDelegate?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Deprecated. MoPub is not available anymore. Use Prebid MAX adapters instead.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @available(*, deprecated, message: "MoPub is not available anymore. Use Prebid MAX adapters instead.")
+@objc
+public func convertDictToMoPubKeywords(dict: Dictionary<String, String>) -> String
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + findNative(adObject:) + +
        +
        +
        +
        +
        +
        +

        Finds a native ad object within a given object.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public func findNative(adObject: AnyObject)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + adObject + + +
        +

        The object to search within.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoAdUnit.html new file mode 100644 index 000000000..241634dd9 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoAdUnit.html @@ -0,0 +1,450 @@ + + + + VideoAdUnit Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      VideoAdUnit

      +
      +
      + + 
      @available(*, deprecated, message: "This class is deprecated. Please, use BannerAdUnit with video adFormat.")
+public class VideoAdUnit : AdUnit
      + +
      +
      +

      A deprecated class for handling video ad units.

      + +
      +
      +
      +
        +
      • +
        + + + + parameters + +
        +
        +
        +
        +
        +
        +

        The parameters for video ads associated with this ad unit.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var parameters: VideoParameters { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(configId:size:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of VideoAdUnit with the specified configuration ID and size.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(configId: String, size: CGSize)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        + + size + + +
        +

        The size of the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Adds additional sizes to the ad unit.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func addAdditionalSize(sizes: [CGSize])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + sizes + + +
        +

        An array of CGSize objects representing the additional sizes for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoControlsConfiguration.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoControlsConfiguration.html new file mode 100644 index 000000000..2d3106de0 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoControlsConfiguration.html @@ -0,0 +1,572 @@ + + + + VideoControlsConfiguration Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      VideoControlsConfiguration

      +
      +
      + + 
      @objc(PBMVideoControlsConfiguration)
+@objcMembers
+public class VideoControlsConfiguration : NSObject
      + +
      +
      +

      A class representing the configuration for video controls in an ad. +This includes properties for video duration, mute status, and button positioning and visibility. +Configuration values can be initialized from bid response or set directly by the user.

      + +
      +
      +
      +
        +
      • +
        + + + + maxVideoDuration + +
        +
        +
        +
        +
        +
        +

        This property indicates maximum video duration. +Obtained from the field ext,prebid.passthrough[].adConfiguration.maxvideoduration.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        private(set) public var maxVideoDuration: NSNumber? { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + isMuted + +
        +
        +
        +
        +
        +
        +

        This property indicates whether the ad should run playback with sound or not. +Obtained from the field ext,prebid.passthrough[].adConfiguration.ismuted or set by user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var isMuted: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + closeButtonArea + +
        +
        +
        +
        +
        +
        +

        This property indicates the area which the close button should occupy on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.closebuttonarea or set by user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var closeButtonArea: Double { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + closeButtonPosition + +
        +
        +
        +
        +
        +
        +

        This property indicates the position of the close button on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.closebuttonposition or set by user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var closeButtonPosition: Position { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + skipButtonArea + +
        +
        +
        +
        +
        +
        +

        This property indicates the area which the skip button should occupy on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.skipbuttonarea or set by user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var skipButtonArea: Double { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + skipButtonPosition + +
        +
        +
        +
        +
        +
        +

        This property indicates the position of the skip button on the screen. +Obtained from the field ext,prebid.passthrough[].adConfiguration.skipbuttonposition or set by user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var skipButtonPosition: Position { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + skipDelay + +
        +
        +
        +
        +
        +
        +

        This property indicates the number of seconds which should be passed from the start of playback until the skip or close button should be shown. +Obtained from the field ext,prebid.passthrough[].adConfiguration.skipdelay or set by user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var skipDelay: Double
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + isSoundButtonVisible + +
        +
        +
        +
        +
        +
        +

        This property indicates whether mute controls is visible on the screen.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var isSoundButtonVisible: Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + initialize(with:) + +
        +
        +
        +
        +
        +
        +

        Use to initialize video controls with server values.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func initialize(with ortbAdConfiguration: PBMORTBAdConfiguration?)
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoInterstitialAdUnit.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoInterstitialAdUnit.html new file mode 100644 index 000000000..1c45d986e --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoInterstitialAdUnit.html @@ -0,0 +1,466 @@ + + + + VideoInterstitialAdUnit Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      VideoInterstitialAdUnit

      +
      +
      + + 
      @available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")
+public class VideoInterstitialAdUnit : AdUnit
      + +
      +
      +

      A deprecated class representing a video interstitial ad unit. +This class is used to configure and manage video interstitial ads. It inherits from AdUnit and provides +specific settings for video ads including interstitial ad configuration and placement.

      + +
      +
      +
      +
        +
      • +
        + + + + parameters + +
        +
        +
        +
        +
        +
        +

        The video parameters for this ad unit. +This property allows you to get or set the video parameters for the ad unit’s configuration.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var parameters: VideoParameters { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(configId:) + +
        +
        +
        +
        +
        +
        +

        Initializes a new instance of VideoInterstitialAdUnit with the specified configuration ID. +The ad unit is configured as an interstitial ad with full screen placement and video parameters set for interstitial ads.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(configId: String)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Convenience initializer to create a video interstitial ad unit with specified minimum width and height percentages.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public convenience init(configId: String, minWidthPerc: Int, minHeightPerc: Int)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + + + + + +
        + + configId + + +
        +

        The configuration ID for the ad unit.

        +
        +
        + + minWidthPerc + + +
        +

        The minimum width percentage of the ad unit.

        +
        +
        + + minHeightPerc + + +
        +

        The minimum height percentage of the ad unit.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoParameters.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoParameters.html new file mode 100644 index 000000000..eaf4dc9a2 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Classes/VideoParameters.html @@ -0,0 +1,814 @@ + + + + VideoParameters Class Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      VideoParameters

      +
      +
      + + 
      @objcMembers
+public class VideoParameters : NSObject
      + +
      +
      +

      Describes an OpenRTB video object

      + +
      +
      +
      +
        +
      • +
        + + + + api + +
        +
        +
        +
        +
        +
        +

        List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var api: [Signals.Api]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + maxBitrate + +
        +
        +
        +
        +
        +
        +

        Maximum bit rate in Kbps.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var maxBitrate: SingleContainerInt?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + minBitrate + +
        +
        +
        +
        +
        +
        +

        Maximum bit rate in Kbps.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var minBitrate: SingleContainerInt?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + maxDuration + +
        +
        +
        +
        +
        +
        +

        Maximum video ad duration in seconds.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var maxDuration: SingleContainerInt?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + minDuration + +
        +
        +
        +
        +
        +
        +

        Minimum video ad duration in seconds.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var minDuration: SingleContainerInt?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + mimes + +
        +
        +
        +
        +
        +
        +

        Content MIME types supported. +Prebid Server required property.

        +

        Example

        + +

        “video/mp4” +“video/x-ms-wmv”

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var mimes: [String]
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + playbackMethod + +
        +
        +
        +
        +
        +
        +

        Allowed playback methods. If none specified, assume all are allowed.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var playbackMethod: [Signals.PlaybackMethod]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + protocols + +
        +
        +
        +
        +
        +
        +

        Array of supported video bid response protocols.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var protocols: [Signals.Protocols]?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + startDelay + +
        +
        +
        +
        +
        +
        +

        Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var startDelay: Signals.StartDelay?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + placement + +
        +
        +
        +
        +
        +
        +

        Placement type for the impression.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var placement: Signals.Placement?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + linearity + +
        +
        +
        +
        +
        +
        +

        Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var linearity: SingleContainerInt?
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + adSize + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var adSize: CGSize?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + + +
      + +

      Helpers +

      +
      +
      +
        +
      • +
        + + + + rawAPI + +
        +
        +
        +
        +
        +
        +

        Helper property

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var rawAPI: [Int]? { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + rawPlaybackMethod + +
        +
        +
        +
        +
        +
        +

        Helper property

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var rawPlaybackMethod: [Int]? { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + rawProtocols + +
        +
        +
        +
        +
        +
        +

        Helper property

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var rawProtocols: [Int]? { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + init(mimes:) + +
        +
        +
        +
        +
        +
        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public init(mimes: [String])
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + mimes + + +
        +

        supported MIME types

        +
        +
        +
        +
        +
        +
        • +
      • +
        + + + + setSize(_:) + +
        +
        +
        +
        +
        +
        +

        Objective-C API

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func setSize(_ size: NSValue)
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums.html new file mode 100644 index 000000000..3c768acfd --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums.html @@ -0,0 +1,603 @@ + + + + Enumerations Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Enumerations

      +

      The following enumerations are available globally.

      + +
      +
      +
      +
        +
      • +
        + + + + DataAsset + +
        +
        +
        +
        +
        +
        +

        Enum representing different types of native data assets.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public enum DataAsset : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + NativeDataAssetType + +
        +
        +
        +
        +
        +
        +

        Enum representing various types of native data assets that can be used in ads.

        + +

        Each case represents a different type of data that can be provided in a native ad response. +Values are defined according to the type of data they represent, such as descriptive text, ratings, or pricing information.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public enum NativeDataAssetType : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + NativeImageAssetType + +
        +
        +
        +
        +
        +
        +

        Enum representing various types of native image assets used in ads.

        + +

        Each case corresponds to a different type of image asset that can be used in native ads. +Values are defined according to the role or importance of the image in the ad.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public enum NativeImageAssetType : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Gender + +
        +
        +
        +
        +
        +
        +

        An enumeration representing gender options for ad targeting or other purposes. +This enum is used to specify different gender options and is intended for use in contexts where gender information may be relevant.

        + +
          +
        • unknown: Gender is not specified or unknown.
          • +
        • male: Represents the male gender.
          • +
        • female: Represents the female gender.
          • +
        • other: Represents any other gender that does not fit into the male or female categories.
          • +
        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBMGender)
+public enum Gender : Int
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Enum representing the initialization status of the Prebid SDK.

        + +

        This enum provides various statuses that indicate the result of the Prebid SDK initialization process. It helps in understanding whether the SDK was successfully initialized or if there were issues during the initialization.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public enum PrebidInitializationStatus : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + PrebidHost + +
        +
        +
        +
        +
        +
        +

        PrebidHost represents various Prebid server hosts used for ad bidding.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public enum PrebidHost : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + AdPosition + +
        +
        +
        +
        +
        +
        +

        Ad position on screen. Refer to List 5.4: +The following table specifies the position of the ad as a relative measure of visibility or prominence. This +OpenRTB table has values derived from the Inventory Quality Guidelines (IQG). Practitioners should +keep in sync with updates to the IQG values as published on IAB.com. Values “4” - “7” apply to apps per +the mobile addendum to IQG version 2.1. +Value Description +0 Unknown +1 Above the Fold +2 DEPRECATED - May or may not be initially visible depending on screen size/resolution. +3 Below the Fold +4 Header +5 Footer +6 Sidebar +7 Full Screen

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBMAdPosition)
+public enum AdPosition : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Position + +
        +
        +
        +
        +
        +
        +

        Enum representing various positions on the screen.

        + +

        This enum defines positions that can be used for placing elements within an ad. The positions are typically used to determine where controls or components should be located within the ad’s user interface.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc(PBMPosition)
+public enum Position : Int
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ResultCode + +
        +
        +
        +
        +
        +
        +

        Enum representing the result codes for various operations within the Prebid SDK.

        + +

        This enum provides a range of result codes indicating different outcomes or errors that may occur during SDK operations. Each case corresponds to a specific result or error, which helps in diagnosing issues and understanding the status of SDK operations.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public enum ResultCode : Int
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/AdPosition.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/AdPosition.html new file mode 100644 index 000000000..62c07eea8 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/AdPosition.html @@ -0,0 +1,467 @@ + + + + AdPosition Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      AdPosition

      +
      +
      + + 
      @objc(PBMAdPosition)
+public enum AdPosition : Int
      + +
      +
      +

      Ad position on screen. Refer to List 5.4: +The following table specifies the position of the ad as a relative measure of visibility or prominence. This +OpenRTB table has values derived from the Inventory Quality Guidelines (IQG). Practitioners should +keep in sync with updates to the IQG values as published on IAB.com. Values “4” - “7” apply to apps per +the mobile addendum to IQG version 2.1. +Value Description +0 Unknown +1 Above the Fold +2 DEPRECATED - May or may not be initially visible depending on screen size/resolution. +3 Below the Fold +4 Header +5 Footer +6 Sidebar +7 Full Screen

      + +
      +
      +
      +
        +
      • +
        + + + + undefined + +
        +
        +
        +
        +
        +
        +

        0 Unknown

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case undefined = 0
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + header + +
        +
        +
        +
        +
        +
        +

        4 Header

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case header = 4
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + footer + +
        +
        +
        +
        +
        +
        +

        5 Footer

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case footer = 5
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + sidebar + +
        +
        +
        +
        +
        +
        +

        6 Sidebar

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case sidebar = 6
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + fullScreen + +
        +
        +
        +
        +
        +
        +

        7 Full Screen

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case fullScreen = 7
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/DataAsset.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/DataAsset.html new file mode 100644 index 000000000..3be5bc0e0 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/DataAsset.html @@ -0,0 +1,701 @@ + + + + DataAsset Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      DataAsset

      +
      +
      + + 
      @objc
+public enum DataAsset : Int
      + +
      +
      +

      Enum representing different types of native data assets.

      + +
      +
      +
      +
        +
      • +
        + + + + sponsored + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case sponsored = 1
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + description + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case description = 2
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + rating + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case rating = 3
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + likes + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case likes = 4
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + downloads + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case downloads = 5
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + price + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case price = 6
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + saleprice + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case saleprice = 7
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + phone + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case phone = 8
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + address + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case address = 9
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + description2 + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case description2 = 10
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + displayurl + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case displayurl = 11
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ctatext + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case ctatext = 12
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + Custom + +
        +
        +
        +
        +
        +
        +

        Custom type for user-defined data assets

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case Custom
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + exchangeID + +
        +
        +
        +
        +
        +
        +

        Gets or sets the exchange ID for the asset type.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public var exchangeID: Int { get set }
        + +
        +
        +
        +

        Return Value

        +

        The exchange ID for the asset type.

        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/Gender.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/Gender.html new file mode 100644 index 000000000..bf8605016 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/Gender.html @@ -0,0 +1,435 @@ + + + + Gender Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Gender

      +
      +
      + + 
      @objc(PBMGender)
+public enum Gender : Int
      + +
      +
      +

      An enumeration representing gender options for ad targeting or other purposes. +This enum is used to specify different gender options and is intended for use in contexts where gender information may be relevant.

      + +
        +
      • unknown: Gender is not specified or unknown.
        • +
      • male: Represents the male gender.
        • +
      • female: Represents the female gender.
        • +
      • other: Represents any other gender that does not fit into the male or female categories.
        • +
      + +
      +
      +
      +
        +
      • +
        + + + + unknown + +
        +
        +
        +
        +
        +
        +

        Gender is not specified or unknown.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case unknown
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + male + +
        +
        +
        +
        +
        +
        +

        Represents the male gender.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case male
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + female + +
        +
        +
        +
        +
        +
        +

        Represents the female gender.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case female
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + other + +
        +
        +
        +
        +
        +
        +

        Represents any other gender that does not fit into the male or female categories.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case other
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/NativeDataAssetType.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/NativeDataAssetType.html new file mode 100644 index 000000000..c8e911c7e --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/NativeDataAssetType.html @@ -0,0 +1,700 @@ + + + + NativeDataAssetType Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeDataAssetType

      +
      +
      + + 
      @objc
+public enum NativeDataAssetType : Int
      + +
      +
      +

      Enum representing various types of native data assets that can be used in ads.

      + +

      Each case represents a different type of data that can be provided in a native ad response. +Values are defined according to the type of data they represent, such as descriptive text, ratings, or pricing information.

      + +
      +
      +
      +
        +
      • +
        + + + + undefined + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case undefined = 0
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + sponsored + +
        +
        +
        +
        +
        +
        +

        Sponsored By message where response should contain the brand name of the sponsor.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case sponsored = 1
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + desc + +
        +
        +
        +
        +
        +
        +

        Descriptive text associated with the product or service being advertised. Longer length of text in response may be truncated or ellipsed by the exchange.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case desc = 2
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + rating + +
        +
        +
        +
        +
        +
        +

        Rating of the product being offered to the user. For example an app’s rating in an app store from 0-5.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case rating = 3
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + likes + +
        +
        +
        +
        +
        +
        +

        Number of social ratings or “likes” of the product being offered to the user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case likes = 4
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + downloads + +
        +
        +
        +
        +
        +
        +

        Number downloads/installs of this product

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case downloads = 5
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + price + +
        +
        +
        +
        +
        +
        +

        Price for product / app / in-app purchase. Value should include currency symbol in localised format.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case price = 6
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + salePrice + +
        +
        +
        +
        +
        +
        +

        Sale price that can be used together with price to indicate a discounted price compared to a regular price. Value should include currency symbol in localised format.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case salePrice = 7
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + phone + +
        +
        +
        +
        +
        +
        +

        Phone number

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case phone = 8
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + address + +
        +
        +
        +
        +
        +
        +

        Address

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case address = 9
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + desc2 + +
        +
        +
        +
        +
        +
        +

        Additional descriptive text associated text with the product or service being advertised

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case desc2 = 10
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + displayURL + +
        +
        +
        +
        +
        +
        +

        Display URL for the text ad. To be used when sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in this field).

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case displayURL = 11
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + ctaText + +
        +
        +
        +
        +
        +
        +

        CTA description - descriptive text describing a ‘call to action’ button for the destination URL.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case ctaText = 12
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + custom + +
        +
        +
        +
        +
        +
        +

        Reserved for Exchange specific usage numbered above 500

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case custom = 500
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/NativeImageAssetType.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/NativeImageAssetType.html new file mode 100644 index 000000000..4ea57b2c0 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/NativeImageAssetType.html @@ -0,0 +1,403 @@ + + + + NativeImageAssetType Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeImageAssetType

      +
      +
      + + 
      @objc
+public enum NativeImageAssetType : Int
      + +
      +
      +

      Enum representing various types of native image assets used in ads.

      + +

      Each case corresponds to a different type of image asset that can be used in native ads. +Values are defined according to the role or importance of the image in the ad.

      + +
      +
      +
      +
        +
      • +
        + + + + icon + +
        +
        +
        +
        +
        +
        +

        Represents an icon image, which is typically a small image used as a visual representation of the product or service.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case icon = 1
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + main + +
        +
        +
        +
        +
        +
        +

        Represents the main image of the ad, which is usually the primary visual element and central to the ad’s presentation.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case main = 3
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + custom + +
        +
        +
        +
        +
        +
        +

        Reserved for exchange-specific usage.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case custom = 500
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/Position.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/Position.html new file mode 100644 index 000000000..14f111de7 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/Position.html @@ -0,0 +1,614 @@ + + + + Position Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Position

      +
      +
      + + 
      @objc(PBMPosition)
+public enum Position : Int
      + +
      +
      +

      Enum representing various positions on the screen.

      + +

      This enum defines positions that can be used for placing elements within an ad. The positions are typically used to determine where controls or components should be located within the ad’s user interface.

      + +
      +
      +
      +
        +
      • +
        + + + + undefined + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case undefined = -1
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + topLeft + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case topLeft
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + topCenter + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case topCenter
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + topRight + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case topRight
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + center + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case center
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + bottomLeft + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case bottomLeft
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + bottomCenter + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case bottomCenter
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + bottomRight + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case bottomRight
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + custom + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case custom
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Returns the corresponding Position enum value for a given string literal.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public static func getPositionByStringLiteral(_ stringValue: String) -> Position?
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + stringValue + + +
        +

        A string representing the position.

        +
        +
        +
        +
        +

        Return Value

        +

        The Position enum value if it matches one of the predefined cases; otherwise, returns nil.

        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/PrebidHost.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/PrebidHost.html new file mode 100644 index 000000000..eee1d26a0 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/PrebidHost.html @@ -0,0 +1,400 @@ + + + + PrebidHost Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PrebidHost

      +
      +
      + + 
      @objc
+public enum PrebidHost : Int
      + +
      +
      +

      PrebidHost represents various Prebid server hosts used for ad bidding.

      + +
      +
      +
      + +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/PrebidInitializationStatus.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/PrebidInitializationStatus.html new file mode 100644 index 000000000..267f990dc --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/PrebidInitializationStatus.html @@ -0,0 +1,402 @@ + + + + PrebidInitializationStatus Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PrebidInitializationStatus

      +
      +
      + + 
      @objc
+public enum PrebidInitializationStatus : Int
      + +
      +
      +

      Enum representing the initialization status of the Prebid SDK.

      + +

      This enum provides various statuses that indicate the result of the Prebid SDK initialization process. It helps in understanding whether the SDK was successfully initialized or if there were issues during the initialization.

      + +
      +
      +
      +
        +
      • +
        + + + + succeeded + +
        +
        +
        +
        +
        +
        +

        Prebid SDK successfully initialized.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case succeeded
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + failed + +
        +
        +
        +
        +
        +
        +

        Prebid SDK is not able to work.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case failed
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + serverStatusWarning + +
        +
        +
        +
        +
        +
        +

        Something went wrong during PBS status checking.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case serverStatusWarning
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/ResultCode.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/ResultCode.html new file mode 100644 index 000000000..f95bb3288 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Enums/ResultCode.html @@ -0,0 +1,834 @@ + + + + ResultCode Enumeration Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      ResultCode

      +
      +
      + + 
      @objc
+public enum ResultCode : Int
      + +
      +
      +

      Enum representing the result codes for various operations within the Prebid SDK.

      + +

      This enum provides a range of result codes indicating different outcomes or errors that may occur during SDK operations. Each case corresponds to a specific result or error, which helps in diagnosing issues and understanding the status of SDK operations.

      + +
      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        The demand fetch request was successful.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidDemandFetchSuccess = 0
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        The Prebid server was not specified in the request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidServerNotSpecified
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        The account ID provided is not recognized by the Prebid server.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidInvalidAccountId
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidInvalidConfigId + +
        +
        +
        +
        +
        +
        +

        The config ID provided is not recognized by the Prebid server.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidInvalidConfigId
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidInvalidSize + +
        +
        +
        +
        +
        +
        +

        The size requested is not recognized by the Prebid server.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidInvalidSize
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidNetworkError + +
        +
        +
        +
        +
        +
        +

        There was a network error during the operation.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidNetworkError
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidServerError + +
        +
        +
        +
        +
        +
        +

        The Prebid server encountered an error while processing the request.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidServerError
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidDemandNoBids + +
        +
        +
        +
        +
        +
        +

        The Prebid server did not return any bids.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidDemandNoBids
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidDemandTimedOut + +
        +
        +
        +
        +
        +
        +

        The demand request timed out.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidDemandTimedOut
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        The URL of the Prebid server is invalid.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidServerURLInvalid
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidUnknownError + +
        +
        +
        +
        +
        +
        +

        An unknown error occurred within the Prebid SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidUnknownError
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        The structure of the response received is invalid.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidInvalidResponseStructure = 1000
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        An internal error occurred within the SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidInternalSDKError = 7000
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidWrongArguments + +
        +
        +
        +
        +
        +
        +

        Incorrect arguments were provided to the SDK.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidWrongArguments
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        No VAST tag was found in the media data.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidNoVastTagInMediaData
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidSDKMisuse + +
        +
        +
        +
        +
        +
        +

        Misuse of the SDK was detected.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidSDKMisuse = 8000
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        SDK misuse due to a previous fetch operation not being completed yet.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidSDKMisusePreviousFetchNotCompletedYet
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + prebidInvalidRequest + +
        +
        +
        +
        +
        +
        +

        The Prebid request does not contain any parameters.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        case prebidInvalidRequest
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + name() + +
        +
        +
        +
        +
        +
        +

        Returns a descriptive name for the result code.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public func name() -> String
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols.html new file mode 100644 index 000000000..027aa6c27 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols.html @@ -0,0 +1,552 @@ + + + + Protocols Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Protocols

      +

      The following protocols are available globally.

      + +
      +
      +
      +
        +
      • +
        + + + + NativeAdDelegate + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol NativeAdDelegate
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + NativeAdEventDelegate + +
        +
        +
        +
        +
        +
        +

        A protocol for handling events related to native ads.

        + +

        This protocol defines optional methods that can be implemented to handle various events associated with native ads, such as expiration, clicks, and impressions. Implementing this protocol allows for custom handling of these events within the native ad lifecycle.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol NativeAdEventDelegate
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + BannerEventHandler + +
        +
        +
        +
        +
        +
        +

        A protocol for handling events related to banner ads in the PBM SDK.

        + +

        This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol BannerEventHandler : PBMPrimaryAdRequesterProtocol
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + BannerViewDelegate + +
        +
        +
        +
        +
        +
        +

        A protocol for handling events related to banner ads in the PBM SDK.

        + +

        This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol BannerViewDelegate : NSObjectProtocol
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Protocol for interaction with the InterstitialAdUnit .

        + +

        All messages will be invoked on the main thread.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol InterstitialAdUnitDelegate : NSObjectProtocol
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Protocol for interaction with the RewardedAdUnit +All messages will be invoked on the main thread.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol RewardedAdUnitDelegate : NSObjectProtocol
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        A protocol for handling events related to rewarded ads.

        + +

        This protocol extends PBMInterstitialAd and defines properties for delegates that handle events related to the ad server communication and user interactions with rewarded ads. Implementing this protocol allows for custom handling of these events within the rewarded ad lifecycle.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol RewardedEventHandlerProtocol : PBMInterstitialAd
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        This protocol is dedicated to manage the work with Mediation SDKs.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+public protocol PrebidMediationDelegate
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/BannerEventHandler.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/BannerEventHandler.html new file mode 100644 index 000000000..321f20106 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/BannerEventHandler.html @@ -0,0 +1,430 @@ + + + + BannerEventHandler Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      BannerEventHandler

      +
      +
      + + 
      @objc
+public protocol BannerEventHandler : PBMPrimaryAdRequesterProtocol
      + +
      +
      +

      A protocol for handling events related to banner ads in the PBM SDK.

      + +

      This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

      + +
      +
      +
      +
        +
      • +
        + + + + loadingDelegate + +
        +
        +
        +
        +
        +
        +

        Delegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        weak var loadingDelegate: BannerEventLoadingDelegate? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + interactionDelegate + +
        +
        +
        +
        +
        +
        +

        Delegate for custom event handler to inform the PBM SDK about the events related to the user’s interaction with the ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        weak var interactionDelegate: BannerEventInteractionDelegate? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + adSizes + +
        +
        +
        +
        +
        +
        +

        The array of the CGRect entries for each valid ad sizes. +The first size is treated as a frame for related ad unit.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        var adSizes: [CGSize] { get }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + trackImpression() + +
        +
        +
        +
        +
        +
        +

        Undocumented

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func trackImpression()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/BannerViewDelegate.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/BannerViewDelegate.html new file mode 100644 index 000000000..414eca8db --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/BannerViewDelegate.html @@ -0,0 +1,581 @@ + + + + BannerViewDelegate Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      BannerViewDelegate

      +
      +
      + + 
      @objc
+public protocol BannerViewDelegate : NSObjectProtocol
      + +
      +
      +

      A protocol for handling events related to banner ads in the PBM SDK.

      + +

      This protocol defines methods and properties for managing events associated with banner ads, including loading events, user interactions, and ad sizes. Implementing this protocol allows for custom handling of these events within the PBM SDK.

      + +
      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Asks the delegate for a view controller instance to use for presenting modal views +as a result of user interaction on an ad. Usual implementation may simply return self, +if it is view controller class.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func bannerViewPresentationController() -> UIViewController?
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Notifies the delegate that an ad has been successfully loaded and rendered.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func bannerView(_ bannerView: BannerView, didReceiveAdWithAdSize adSize: CGSize)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + bannerView + + +
        +

        The BannerView instance sending the message.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Notifies the delegate of an error encountered while loading or rendering an ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func bannerView(_ bannerView: BannerView,
+                         didFailToReceiveAdWith error: Error)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + bannerView + + +
        +

        The BannerView instance sending the message.

        +
        +
        + + error + + +
        +

        The error encountered while attempting to receive or render the

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Notifies the delegate whenever current app goes in the background due to user click.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func bannerViewWillLeaveApplication(_ bannerView: BannerView)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + bannerView + + +
        +

        The BannerView instance sending the message.

        +
        +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Notifies delegate that the banner view will launch a modal +on top of the current view controller, as a result of user interaction.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func bannerViewWillPresentModal(_ bannerView: BannerView)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Notifies delegate that the banner view has dismissed the modal on top of +the current view controller.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func bannerViewDidDismissModal(_ bannerView: BannerView)
        + +
        +
        +
        +

        Parameters

        + + + + + + + +
        + + bannerView + + +
        +

        The BannerView instance sending the message.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/InterstitialAdUnitDelegate.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/InterstitialAdUnitDelegate.html new file mode 100644 index 000000000..b2fbfc863 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/InterstitialAdUnitDelegate.html @@ -0,0 +1,490 @@ + + + + InterstitialAdUnitDelegate Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      InterstitialAdUnitDelegate

      +
      +
      + + 
      @objc
+public protocol InterstitialAdUnitDelegate : NSObjectProtocol
      + +
      +
      +

      Protocol for interaction with the InterstitialAdUnit .

      + +

      All messages will be invoked on the main thread.

      + +
      +
      +
      + +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/NativeAdDelegate.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/NativeAdDelegate.html new file mode 100644 index 000000000..3d5bc5dfe --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/NativeAdDelegate.html @@ -0,0 +1,402 @@ + + + + NativeAdDelegate Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAdDelegate

      +
      +
      + + 
      @objc
+public protocol NativeAdDelegate
      + +
      +
      +

      Undocumented

      + +
      +
      +
      +
        +
      • +
        + + + + nativeAdLoaded(ad:) + +
        +
        +
        +
        +
        +
        +

        A successful Prebid Native ad is returned

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func nativeAdLoaded(ad: NativeAd)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + nativeAdNotFound() + +
        +
        +
        +
        +
        +
        +

        Prebid Native was not found in the server returned response, +Please display the ad as regular ways

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func nativeAdNotFound()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + nativeAdNotValid() + +
        +
        +
        +
        +
        +
        +

        Prebid Native ad was returned, however, the bid is not valid for displaying +Should be treated as on ad load failed

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func nativeAdNotValid()
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/NativeAdEventDelegate.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/NativeAdEventDelegate.html new file mode 100644 index 000000000..324e29d61 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/NativeAdEventDelegate.html @@ -0,0 +1,405 @@ + + + + NativeAdEventDelegate Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      NativeAdEventDelegate

      +
      +
      + + 
      @objc
+public protocol NativeAdEventDelegate
      + +
      +
      +

      A protocol for handling events related to native ads.

      + +

      This protocol defines optional methods that can be implemented to handle various events associated with native ads, such as expiration, clicks, and impressions. Implementing this protocol allows for custom handling of these events within the native ad lifecycle.

      + +
      +
      +
      +
        +
      • +
        + + + + adDidExpire(ad:) + +
        +
        +
        +
        +
        +
        +

        Sent when the native ad is expired.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func adDidExpire(ad: NativeAd)
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + adWasClicked(ad:) + +
        +
        +
        +
        +
        +
        +

        Sent when the native view is clicked by the user.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func adWasClicked(ad: NativeAd)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Sent when an impression is recorded for an native ad

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func adDidLogImpression(ad: NativeAd)
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/PrebidMediationDelegate.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/PrebidMediationDelegate.html new file mode 100644 index 000000000..5f6660395 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/PrebidMediationDelegate.html @@ -0,0 +1,404 @@ + + + + PrebidMediationDelegate Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      PrebidMediationDelegate

      +
      +
      + + 
      @objc
+public protocol PrebidMediationDelegate
      + +
      +
      +

      This protocol is dedicated to manage the work with Mediation SDKs.

      + +
      +
      +
      +
        +
      • +
        + + + + setUpAdObject(with:) + +
        +
        +
        +
        +
        +
        +

        Puts to ad object’s localExtra the ad object (winning bid or native ad) and configId +and populates adObject’s keywords by targeting info +@return YES on success and NO otherwise (when the passed ad has wrong type)

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func setUpAdObject(with values: [String : Any]) -> Bool
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + cleanUpAdObject() + +
        +
        +
        +
        +
        +
        +

        Removes an bid info from ad object’s localExtra +and prebid-specific keywords from ad object’s keywords

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func cleanUpAdObject()
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + getAdView() + +
        +
        +
        +
        +
        +
        +

        Returns ad view that was passed into PrebidMediationDelegate earlier. +Returns nil if there was no view passed.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        func getAdView() -> UIView?
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/RewardedAdUnitDelegate.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/RewardedAdUnitDelegate.html new file mode 100644 index 000000000..feb243665 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/RewardedAdUnitDelegate.html @@ -0,0 +1,517 @@ + + + + RewardedAdUnitDelegate Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      RewardedAdUnitDelegate

      +
      +
      + + 
      @objc
+public protocol RewardedAdUnitDelegate : NSObjectProtocol
      + +
      +
      +

      Protocol for interaction with the RewardedAdUnit +All messages will be invoked on the main thread.

      + +
      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        Called when an ad is loaded and ready for display

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAdDidReceiveAd(_ rewardedAd: RewardedAdUnit)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when user is able to receive a reward from the app

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAdUserDidEarnReward(_ rewardedAd: RewardedAdUnit)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the load process fails to produce a viable ad

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAd(_ rewardedAd: RewardedAdUnit,
+                         didFailToReceiveAdWithError error: Error?)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the interstitial view will be launched, as a result of show() method.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAdWillPresentAd(_ rewardedAd: RewardedAdUnit)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when the interstial is dismissed by the user

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAdDidDismissAd(_ rewardedAd: RewardedAdUnit)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when an ad causes the sdk to leave the app

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAdWillLeaveApplication(_ rewardedAd: RewardedAdUnit)
        + +
        +
        +
        +
        +
        • +
      • + +
        +
        +
        +
        +
        +

        Called when user clicked the ad

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        @objc
+optional func rewardedAdDidClickAd(_ rewardedAd: RewardedAdUnit)
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/RewardedEventHandlerProtocol.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/RewardedEventHandlerProtocol.html new file mode 100644 index 000000000..ad7b28853 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Protocols/RewardedEventHandlerProtocol.html @@ -0,0 +1,375 @@ + + + + RewardedEventHandlerProtocol Protocol Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      RewardedEventHandlerProtocol

      +
      +
      + + 
      @objc
+public protocol RewardedEventHandlerProtocol : PBMInterstitialAd
      + +
      +
      +

      A protocol for handling events related to rewarded ads.

      + +

      This protocol extends PBMInterstitialAd and defines properties for delegates that handle events related to the ad server communication and user interactions with rewarded ads. Implementing this protocol allows for custom handling of these events within the rewarded ad lifecycle.

      + +
      +
      +
      +
        +
      • +
        + + + + loadingDelegate + +
        +
        +
        +
        +
        +
        +

        Delegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        weak var loadingDelegate: RewardedEventLoadingDelegate? { get set }
        + +
        +
        +
        +
        +
        • +
      • +
        + + + + interactionDelegate + +
        +
        +
        +
        +
        +
        +

        Delegate for custom event handler to inform the PBM SDK about the events related to the user’s interaction with the ad.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        weak var interactionDelegate: RewardedEventInteractionDelegate? { get set }
        + +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Typealiases.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Typealiases.html new file mode 100644 index 000000000..be28a8e74 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/Typealiases.html @@ -0,0 +1,369 @@ + + + + Type Aliases Reference + + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      +

      Type Aliases

      +

      The following type aliases are available globally.

      + +
      +
      +
      +
        +
      • + +
        +
        +
        +
        +
        +

        A callback used for Prebid initialization status.

        + +

        This callback is called when the Prebid SDK initialization completes. It provides the status of the initialization and any error that may have occurred.

        + +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public typealias PrebidInitializationCallback = ((PrebidInitializationStatus, Error?) -> Void)
        + +
        +
        +
        +

        Parameters

        + + + + + + + + + + + +
        + + status + + +
        +

        The status of the Prebid initialization.

        +
        +
        + + error + + +
        +

        An optional error that occurred during initialization.

        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/css/highlight.css b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/css/highlight.css new file mode 100644 index 000000000..c170357ce --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/css/jazzy.css b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/css/jazzy.css new file mode 100644 index 000000000..f84ef864f --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/css/jazzy.css @@ -0,0 +1,442 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { + background: transparent; + border: 0; + margin: 0; + outline: 0; + padding: 0; + vertical-align: baseline; } + +body { + background-color: #f2f2f2; + font-family: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + -webkit-font-smoothing: subpixel-antialiased; + word-wrap: break-word; } + +h1, h2, h3 { + margin-top: 0.8em; + margin-bottom: 0.3em; + font-weight: 100; + color: black; } + +h1 { + font-size: 2.5em; } + +h2 { + font-size: 2em; + border-bottom: 1px solid #e2e2e2; } + +h4 { + font-size: 13px; + line-height: 1.5; + margin-top: 21px; } + +h5 { + font-size: 1.1em; } + +h6 { + font-size: 1.1em; + color: #777; } + +.section-name { + color: gray; + display: block; + font-family: Helvetica; + font-size: 22px; + font-weight: 100; + margin-bottom: 15px; } + +pre, code { + font: 0.95em Menlo, monospace; + color: #777; + word-wrap: normal; } + +p code, li code { + background-color: #eee; + padding: 2px 4px; + border-radius: 4px; } + +pre > code { + padding: 0; } + +a { + color: #0088cc; + text-decoration: none; } + a code { + color: inherit; } + +ul { + padding-left: 15px; } + +li { + line-height: 1.8em; } + +img { + max-width: 100%; } + +blockquote { + margin-left: 0; + padding: 0 10px; + border-left: 4px solid #ccc; } + +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + +.content-wrapper { + margin: 0 auto; + width: 980px; } + +header { + font-size: 0.85em; + line-height: 32px; + background-color: #414141; + position: fixed; + width: 100%; + z-index: 3; } + header img { + padding-right: 6px; + vertical-align: -3px; + height: 16px; } + header a { + color: #fff; } + header p { + float: left; + color: #999; } + header .header-right { + float: right; + margin-left: 16px; } + +#breadcrumbs { + background-color: #f2f2f2; + height: 26px; + padding-top: 12px; + position: fixed; + width: inherit; + z-index: 2; + margin-top: 32px; + white-space: nowrap; + overflow-x: scroll; } + #breadcrumbs #carat { + height: 10px; + margin: 0 5px; } + +.sidebar { + background-color: #f9f9f9; + border: 1px solid #e2e2e2; + overflow-y: auto; + overflow-x: hidden; + position: fixed; + top: 70px; + bottom: 0; + width: 230px; + word-wrap: normal; } + +.nav-groups { + list-style-type: none; + background: #fff; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #e2e2e2; + font-size: 1.1em; + font-weight: 100; + padding: 15px 0 15px 20px; } + .nav-group-name > a { + color: #333; } + +.nav-group-tasks { + margin-top: 5px; } + +.nav-group-task { + font-size: 0.9em; + list-style-type: none; + white-space: nowrap; } + .nav-group-task a { + color: #888; } + +.main-content { + background-color: #fff; + border: 1px solid #e2e2e2; + margin-left: 246px; + position: absolute; + overflow: hidden; + padding-bottom: 20px; + top: 70px; + width: 734px; } + .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote { + margin-bottom: 1em; } + .main-content p { + line-height: 1.8em; } + .main-content section .section:first-child { + margin-top: 0; + padding-top: 0; } + .main-content section .task-group-section .task-group:first-of-type { + padding-top: 10px; } + .main-content section .task-group-section .task-group:first-of-type .section-name { + padding-top: 15px; } + .main-content section .heading:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .main-content .section-name p { + margin-bottom: inherit; + line-height: inherit; } + .main-content .section-name code { + background-color: inherit; + padding: inherit; + color: inherit; } + +.section { + padding: 0 25px; } + +.highlight { + background-color: #eee; + padding: 10px 12px; + border: 1px solid #e2e2e2; + border-radius: 4px; + overflow-x: auto; } + +.declaration .highlight { + overflow-x: initial; + padding: 0 40px 40px 0; + margin-bottom: -25px; + background-color: transparent; + border: none; } + +.section-name { + margin: 0; + margin-left: 18px; } + +.task-group-section { + margin-top: 10px; + padding-left: 6px; + border-top: 1px solid #e2e2e2; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + +.section-name-container { + position: relative; + display: inline-block; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .item code { + background-color: transparent; + padding: 0; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 35px; + font-size: 11.9px; + transition: all 300ms; } + .item .token-open { + margin-left: 20px; } + .item .discouraged { + text-decoration: line-through; } + +.declaration-note { + font-size: .85em; + color: gray; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #e2e2e2; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + background: #f9f9f9; + border-left: 1px solid #e2e2e2; + border-top: 1px solid #e2e2e2; + height: 12px; + left: 21px; + top: -7px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + position: absolute; + width: 12px; } + +.height-container { + display: none; + left: -25px; + padding: 0 25px; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #f9f9f9; + border-bottom: 1px solid #e2e2e2; + left: -25px; + position: relative; + width: 100%; + padding-top: 10px; + padding-bottom: 5px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4b8afb; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #e2e2e2; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +#footer { + position: relative; + top: 10px; + bottom: 0px; + margin-left: 25px; } + #footer p { + margin: 0; + color: #aaa; + font-size: 0.8em; } + +html.dash header, html.dash #breadcrumbs, html.dash .sidebar { + display: none; } + +html.dash .main-content { + width: 980px; + margin-left: 0; + border: none; + width: 100%; + top: 0; + padding-bottom: 0; } + +html.dash .height-container { + display: block; } + +html.dash .item .token { + margin-left: 0; } + +html.dash .content-wrapper { + width: auto; } + +html.dash #footer { + position: static; } + +form[role=search] { + float: right; } + form[role=search] input { + font: Helvetica, freesans, Arial, sans-serif; + margin-top: 6px; + font-size: 13px; + line-height: 20px; + padding: 0px 10px; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fff; + color: #333; + border: 1px solid #e2e2e2; + z-index: 4; } + form[role=search] .tt-highlight { + font-weight: bold; } + form[role=search] .tt-suggestion { + font: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + form[role=search] .tt-suggestion:hover, + form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + form[role=search] .tt-suggestion:hover .doc-parent-name, + form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/carat.png b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/carat.png new file mode 100755 index 000000000..29d2f7fd4 Binary files /dev/null and b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/carat.png differ diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/dash.png b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/dash.png new file mode 100755 index 000000000..6f694c7a0 Binary files /dev/null and b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/dash.png differ diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/spinner.gif b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/spinner.gif new file mode 100644 index 000000000..e3038d0a4 Binary files /dev/null and b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/img/spinner.gif differ diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/index.html b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/index.html new file mode 100644 index 000000000..9fdcc66c5 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/index.html @@ -0,0 +1,334 @@ + + + + PrebidMobile Reference + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      + +

      Prebid Mobile iOS SDK

      + +

      To work with Prebid Mobile, you will need accesss to a Prebid Server. See this page for options.

      +

      Use Cocoapods?

      + +

      Easily include the Prebid Mobile SDK for your primary ad server in your Podfile/

      +
      platform :ios, '11.0'
+
+target 'MyAmazingApp' do 
+    pod 'PrebidMobile'
+end
+
      +

      Build framework from source

      + +

      Build Prebid Mobile from source code. After cloning the repo, from the root directory run

      +
      ./scripts/buildPrebidMobile.sh
+
      + +

      to output the Prebid Mobile framework.

      +

      Test Prebid Mobile

      + +

      Run the test script to run unit tests and integration tests.

      +
      ./scripts/testPrebidMobile.sh
+
      +

      Carthage

      + +

      2.2.3 version is available to build PrebidMobile with Carthage. For that, please, put the following content to your Cartfile:

      +
      github "prebid/prebid-mobile-ios" == 2.2.3-carthage
+
      + +

      Run this command in order to build PrebidMobile with Carthage:

      +
      carthage update --use-xcframeworks --platform ios
+
      + +

      Note that PrebidMobileGAMEventHandlers, PrebidMobileAdMobAdapters, PrebidMobileMAXAdapters are not available to build with Carthage.

      + +
      +
      + +
      +
      + + diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jazzy.js b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jazzy.js new file mode 100755 index 000000000..198441660 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jazzy.search.js new file mode 100644 index 000000000..359cdbb8b --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
      '; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
      '; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jquery.min.js new file mode 100644 index 000000000..7f37b5d99 --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
      "],col:[2,"","
      "],tr:[2,"","
      "],td:[3,"","
      "],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
      ",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/typeahead.jquery.js new file mode 100644 index 000000000..bcb734bef --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/js/typeahead.jquery.js @@ -0,0 +1,1695 @@ +/*! + * typeahead.js 1.3.3 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2024 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
      ' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + "aria-controls": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
      "); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
      "); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
      ').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
      ").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
      "); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
      "); + $menu = this.menu.$node || $("
      "); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/search.json b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/search.json new file mode 100644 index 000000000..de2d0dd8d --- /dev/null +++ b/docs/docsets/PrebidMobile.docset/Contents/Resources/Documents/search.json @@ -0,0 +1 @@ +{"Typealiases.html#/s:12PrebidMobile0A22InitializationCallbacka":{"name":"PrebidInitializationCallback","abstract":"\u003cp\u003eA callback used for Prebid initialization status.\u003c/p\u003e"},"Protocols/PrebidMediationDelegate.html#/c:@M@PrebidMobile@objc(pl)PrebidMediationDelegate(im)setUpAdObjectWith:":{"name":"setUpAdObject(with:)","abstract":"\u003cp\u003ePuts to ad object\u0026rsquo;s localExtra the ad object (winning bid or native ad) and configId","parent_name":"PrebidMediationDelegate"},"Protocols/PrebidMediationDelegate.html#/c:@M@PrebidMobile@objc(pl)PrebidMediationDelegate(im)cleanUpAdObject":{"name":"cleanUpAdObject()","abstract":"\u003cp\u003eRemoves an bid info from ad object\u0026rsquo;s localExtra","parent_name":"PrebidMediationDelegate"},"Protocols/PrebidMediationDelegate.html#/c:@M@PrebidMobile@objc(pl)PrebidMediationDelegate(im)getAdView":{"name":"getAdView()","abstract":"\u003cp\u003eReturns ad view that was passed into PrebidMediationDelegate earlier.","parent_name":"PrebidMediationDelegate"},"Protocols/RewardedEventHandlerProtocol.html#/c:@M@PrebidMobile@objc(pl)RewardedEventHandlerProtocol(py)loadingDelegate":{"name":"loadingDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.\u003c/p\u003e","parent_name":"RewardedEventHandlerProtocol"},"Protocols/RewardedEventHandlerProtocol.html#/c:@M@PrebidMobile@objc(pl)RewardedEventHandlerProtocol(py)interactionDelegate":{"name":"interactionDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the user\u0026rsquo;s interaction with the ad.\u003c/p\u003e","parent_name":"RewardedEventHandlerProtocol"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdDidReceiveAd:":{"name":"rewardedAdDidReceiveAd(_:)","abstract":"\u003cp\u003eCalled when an ad is loaded and ready for display\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdUserDidEarnReward:":{"name":"rewardedAdUserDidEarnReward(_:)","abstract":"\u003cp\u003eCalled when user is able to receive a reward from the app\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAd:didFailToReceiveAdWithError:":{"name":"rewardedAd(_:didFailToReceiveAdWithError:)","abstract":"\u003cp\u003eCalled when the load process fails to produce a viable ad\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdWillPresentAd:":{"name":"rewardedAdWillPresentAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial view will be launched, as a result of show() method.\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdDidDismissAd:":{"name":"rewardedAdDidDismissAd(_:)","abstract":"\u003cp\u003eCalled when the interstial is dismissed by the user\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdWillLeaveApplication:":{"name":"rewardedAdWillLeaveApplication(_:)","abstract":"\u003cp\u003eCalled when an ad causes the sdk to leave the app\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdDidClickAd:":{"name":"rewardedAdDidClickAd(_:)","abstract":"\u003cp\u003eCalled when user clicked the ad\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialDidReceiveAd:":{"name":"interstitialDidReceiveAd(_:)","abstract":"\u003cp\u003eCalled when an ad is loaded and ready for display\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitial:didFailToReceiveAdWithError:":{"name":"interstitial(_:didFailToReceiveAdWithError:)","abstract":"\u003cp\u003eCalled when the load process fails to produce a viable ad\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialWillPresentAd:":{"name":"interstitialWillPresentAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial view will be launched, as a result of show() method.\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialDidDismissAd:":{"name":"interstitialDidDismissAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial is dismissed by the user\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialWillLeaveApplication:":{"name":"interstitialWillLeaveApplication(_:)","abstract":"\u003cp\u003eCalled when an ad causes the sdk to leave the app\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialDidClickAd:":{"name":"interstitialDidClickAd(_:)","abstract":"\u003cp\u003eCalled when user clicked the ad\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewPresentationController":{"name":"bannerViewPresentationController()","abstract":"\u003cp\u003eAsks the delegate for a view controller instance to use for presenting modal views","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerView:didReceiveAdWithAdSize:":{"name":"bannerView(_:didReceiveAdWithAdSize:)","abstract":"\u003cp\u003eNotifies the delegate that an ad has been successfully loaded and rendered.\u003c/p\u003e","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerView:didFailToReceiveAdWith:":{"name":"bannerView(_:didFailToReceiveAdWith:)","abstract":"\u003cp\u003eNotifies the delegate of an error encountered while loading or rendering an ad.\u003c/p\u003e","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewWillLeaveApplication:":{"name":"bannerViewWillLeaveApplication(_:)","abstract":"\u003cp\u003eNotifies the delegate whenever current app goes in the background due to user click.\u003c/p\u003e","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewWillPresentModal:":{"name":"bannerViewWillPresentModal(_:)","abstract":"\u003cp\u003eNotifies delegate that the banner view will launch a modal","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewDidDismissModal:":{"name":"bannerViewDidDismissModal(_:)","abstract":"\u003cp\u003eNotifies delegate that the banner view has dismissed the modal on top of","parent_name":"BannerViewDelegate"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(py)loadingDelegate":{"name":"loadingDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.\u003c/p\u003e","parent_name":"BannerEventHandler"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(py)interactionDelegate":{"name":"interactionDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the user\u0026rsquo;s interaction with the ad.\u003c/p\u003e","parent_name":"BannerEventHandler"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(py)adSizes":{"name":"adSizes","abstract":"\u003cp\u003eThe array of the CGRect entries for each valid ad sizes.","parent_name":"BannerEventHandler"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(im)trackImpression":{"name":"trackImpression()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerEventHandler"},"Protocols/NativeAdEventDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdEventDelegate(im)adDidExpireWithAd:":{"name":"adDidExpire(ad:)","abstract":"\u003cp\u003eSent when the native ad is expired.\u003c/p\u003e","parent_name":"NativeAdEventDelegate"},"Protocols/NativeAdEventDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdEventDelegate(im)adWasClickedWithAd:":{"name":"adWasClicked(ad:)","abstract":"\u003cp\u003eSent when the native view is clicked by the user.\u003c/p\u003e","parent_name":"NativeAdEventDelegate"},"Protocols/NativeAdEventDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdEventDelegate(im)adDidLogImpressionWithAd:":{"name":"adDidLogImpression(ad:)","abstract":"\u003cp\u003eSent when an impression is recorded for an native ad\u003c/p\u003e","parent_name":"NativeAdEventDelegate"},"Protocols/NativeAdDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdDelegate(im)nativeAdLoadedWithAd:":{"name":"nativeAdLoaded(ad:)","abstract":"\u003cp\u003eA successful Prebid Native ad is returned\u003c/p\u003e","parent_name":"NativeAdDelegate"},"Protocols/NativeAdDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdDelegate(im)nativeAdNotFound":{"name":"nativeAdNotFound()","abstract":"\u003cp\u003ePrebid Native was not found in the server returned response,","parent_name":"NativeAdDelegate"},"Protocols/NativeAdDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdDelegate(im)nativeAdNotValid":{"name":"nativeAdNotValid()","abstract":"\u003cp\u003ePrebid Native ad was returned, however, the bid is not valid for displaying","parent_name":"NativeAdDelegate"},"Protocols/NativeAdDelegate.html":{"name":"NativeAdDelegate","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e"},"Protocols/NativeAdEventDelegate.html":{"name":"NativeAdEventDelegate","abstract":"\u003cp\u003eA protocol for handling events related to native ads.\u003c/p\u003e"},"Protocols/BannerEventHandler.html":{"name":"BannerEventHandler","abstract":"\u003cp\u003eA protocol for handling events related to banner ads in the PBM SDK.\u003c/p\u003e"},"Protocols/BannerViewDelegate.html":{"name":"BannerViewDelegate","abstract":"\u003cp\u003eA protocol for handling events related to banner ads in the PBM SDK.\u003c/p\u003e"},"Protocols/InterstitialAdUnitDelegate.html":{"name":"InterstitialAdUnitDelegate","abstract":"\u003cp\u003eProtocol for interaction with the InterstitialAdUnit .\u003c/p\u003e"},"Protocols/RewardedAdUnitDelegate.html":{"name":"RewardedAdUnitDelegate","abstract":"\u003cp\u003eProtocol for interaction with the RewardedAdUnit"},"Protocols/RewardedEventHandlerProtocol.html":{"name":"RewardedEventHandlerProtocol","abstract":"\u003cp\u003eA protocol for handling events related to rewarded ads.\u003c/p\u003e"},"Protocols/PrebidMediationDelegate.html":{"name":"PrebidMediationDelegate","abstract":"\u003cp\u003eThis protocol is dedicated to manage the work with Mediation SDKs.\u003c/p\u003e"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidDemandFetchSuccess":{"name":"prebidDemandFetchSuccess","abstract":"\u003cp\u003eThe demand fetch request was successful.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidServerNotSpecified":{"name":"prebidServerNotSpecified","abstract":"\u003cp\u003eThe Prebid server was not specified in the request.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidAccountId":{"name":"prebidInvalidAccountId","abstract":"\u003cp\u003eThe account ID provided is not recognized by the Prebid server.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidConfigId":{"name":"prebidInvalidConfigId","abstract":"\u003cp\u003eThe config ID provided is not recognized by the Prebid server.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidSize":{"name":"prebidInvalidSize","abstract":"\u003cp\u003eThe size requested is not recognized by the Prebid server.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidNetworkError":{"name":"prebidNetworkError","abstract":"\u003cp\u003eThere was a network error during the operation.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidServerError":{"name":"prebidServerError","abstract":"\u003cp\u003eThe Prebid server encountered an error while processing the request.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidDemandNoBids":{"name":"prebidDemandNoBids","abstract":"\u003cp\u003eThe Prebid server did not return any bids.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidDemandTimedOut":{"name":"prebidDemandTimedOut","abstract":"\u003cp\u003eThe demand request timed out.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidServerURLInvalid":{"name":"prebidServerURLInvalid","abstract":"\u003cp\u003eThe URL of the Prebid server is invalid.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidUnknownError":{"name":"prebidUnknownError","abstract":"\u003cp\u003eAn unknown error occurred within the Prebid SDK.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidResponseStructure":{"name":"prebidInvalidResponseStructure","abstract":"\u003cp\u003eThe structure of the response received is invalid.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInternalSDKError":{"name":"prebidInternalSDKError","abstract":"\u003cp\u003eAn internal error occurred within the SDK.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidWrongArguments":{"name":"prebidWrongArguments","abstract":"\u003cp\u003eIncorrect arguments were provided to the SDK.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidNoVastTagInMediaData":{"name":"prebidNoVastTagInMediaData","abstract":"\u003cp\u003eNo VAST tag was found in the media data.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidSDKMisuse":{"name":"prebidSDKMisuse","abstract":"\u003cp\u003eMisuse of the SDK was detected.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidSDKMisusePreviousFetchNotCompletedYet":{"name":"prebidSDKMisusePreviousFetchNotCompletedYet","abstract":"\u003cp\u003eSDK misuse due to a previous fetch operation not being completed yet.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidRequest":{"name":"prebidInvalidRequest","abstract":"\u003cp\u003eThe Prebid request does not contain any parameters.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/s:12PrebidMobile10ResultCodeO4nameSSyF":{"name":"name()","abstract":"\u003cp\u003eReturns a descriptive name for the result code.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionUndefined":{"name":"undefined","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionTopLeft":{"name":"topLeft","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionTopCenter":{"name":"topCenter","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionTopRight":{"name":"topRight","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionCenter":{"name":"center","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionBottomLeft":{"name":"bottomLeft","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionBottomCenter":{"name":"bottomCenter","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionBottomRight":{"name":"bottomRight","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionCustom":{"name":"custom","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/s:12PrebidMobile8PositionO03getC15ByStringLiteralyACSgSSFZ":{"name":"getPositionByStringLiteral(_:)","abstract":"\u003cp\u003eReturns the corresponding \u003ccode\u003ePosition\u003c/code\u003e enum value for a given string literal.\u003c/p\u003e","parent_name":"Position"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionUndefined":{"name":"undefined","abstract":"\u003cp\u003e0 Unknown\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionHeader":{"name":"header","abstract":"\u003cp\u003e4 Header\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionFooter":{"name":"footer","abstract":"\u003cp\u003e5 Footer\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionSidebar":{"name":"sidebar","abstract":"\u003cp\u003e6 Sidebar\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionFullScreen":{"name":"fullScreen","abstract":"\u003cp\u003e7 Full Screen\u003c/p\u003e","parent_name":"AdPosition"},"Enums/PrebidHost.html#/c:@M@PrebidMobile@E@PrebidHost@PrebidHostAppnexus":{"name":"Appnexus","abstract":"\u003cp\u003eURL \u003ca href=\"URL\"\u003ehttps://ib.adnxs.com/openrtb2/prebid\u003c/a\u003e\u003c/p\u003e","parent_name":"PrebidHost"},"Enums/PrebidHost.html#/c:@M@PrebidMobile@E@PrebidHost@PrebidHostRubicon":{"name":"Rubicon","abstract":"\u003cp\u003eURL \u003ca href=\"URL\"\u003ehttps://prebid-server.rubiconproject.com/openrtb2/auction\u003c/a\u003e\u003c/p\u003e","parent_name":"PrebidHost"},"Enums/PrebidHost.html#/c:@M@PrebidMobile@E@PrebidHost@PrebidHostCustom":{"name":"Custom","abstract":"\u003cp\u003eCustom Prebid server URL. The URL for this case should be set separately.\u003c/p\u003e","parent_name":"PrebidHost"},"Enums/PrebidInitializationStatus.html#/c:@M@PrebidMobile@E@PrebidInitializationStatus@PrebidInitializationStatusSucceeded":{"name":"succeeded","abstract":"\u003cp\u003ePrebid SDK successfully initialized.\u003c/p\u003e","parent_name":"PrebidInitializationStatus"},"Enums/PrebidInitializationStatus.html#/c:@M@PrebidMobile@E@PrebidInitializationStatus@PrebidInitializationStatusFailed":{"name":"failed","abstract":"\u003cp\u003ePrebid SDK is not able to work.\u003c/p\u003e","parent_name":"PrebidInitializationStatus"},"Enums/PrebidInitializationStatus.html#/c:@M@PrebidMobile@E@PrebidInitializationStatus@PrebidInitializationStatusServerStatusWarning":{"name":"serverStatusWarning","abstract":"\u003cp\u003eSomething went wrong during PBS status checking.\u003c/p\u003e","parent_name":"PrebidInitializationStatus"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderUnknown":{"name":"unknown","abstract":"\u003cp\u003eGender is not specified or unknown.\u003c/p\u003e","parent_name":"Gender"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderMale":{"name":"male","abstract":"\u003cp\u003eRepresents the male gender.\u003c/p\u003e","parent_name":"Gender"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderFemale":{"name":"female","abstract":"\u003cp\u003eRepresents the female gender.\u003c/p\u003e","parent_name":"Gender"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderOther":{"name":"other","abstract":"\u003cp\u003eRepresents any other gender that does not fit into the male or female categories.\u003c/p\u003e","parent_name":"Gender"},"Enums/NativeImageAssetType.html#/c:@M@PrebidMobile@E@NativeImageAssetType@NativeImageAssetTypeIcon":{"name":"icon","abstract":"\u003cp\u003eRepresents an icon image, which is typically a small image used as a visual representation of the product or service.\u003c/p\u003e","parent_name":"NativeImageAssetType"},"Enums/NativeImageAssetType.html#/c:@M@PrebidMobile@E@NativeImageAssetType@NativeImageAssetTypeMain":{"name":"main","abstract":"\u003cp\u003eRepresents the main image of the ad, which is usually the primary visual element and central to the ad\u0026rsquo;s presentation.\u003c/p\u003e","parent_name":"NativeImageAssetType"},"Enums/NativeImageAssetType.html#/c:@M@PrebidMobile@E@NativeImageAssetType@NativeImageAssetTypeCustom":{"name":"custom","abstract":"\u003cp\u003eReserved for exchange-specific usage.\u003c/p\u003e","parent_name":"NativeImageAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeUndefined":{"name":"undefined","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeSponsored":{"name":"sponsored","abstract":"\u003cp\u003eSponsored By message where response should contain the brand name of the sponsor.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDesc":{"name":"desc","abstract":"\u003cp\u003eDescriptive text associated with the product or service being advertised. Longer length of text in response may be truncated or ellipsed by the exchange.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeRating":{"name":"rating","abstract":"\u003cp\u003eRating of the product being offered to the user. For example an app’s rating in an app store from 0-5.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeLikes":{"name":"likes","abstract":"\u003cp\u003eNumber of social ratings or “likes” of the product being offered to the user.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDownloads":{"name":"downloads","abstract":"\u003cp\u003eNumber downloads/installs of this product\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypePrice":{"name":"price","abstract":"\u003cp\u003ePrice for product / app / in-app purchase. Value should include currency symbol in localised format.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeSalePrice":{"name":"salePrice","abstract":"\u003cp\u003eSale price that can be used together with price to indicate a discounted price compared to a regular price. Value should include currency symbol in localised format.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypePhone":{"name":"phone","abstract":"\u003cp\u003ePhone number\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeAddress":{"name":"address","abstract":"\u003cp\u003eAddress\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDesc2":{"name":"desc2","abstract":"\u003cp\u003eAdditional descriptive text associated text with the product or service being advertised\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDisplayURL":{"name":"displayURL","abstract":"\u003cp\u003eDisplay URL for the text ad. To be used when sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in this field).\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeCtaText":{"name":"ctaText","abstract":"\u003cp\u003eCTA description - descriptive text describing a ‘call to action’ button for the destination URL.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeCustom":{"name":"custom","abstract":"\u003cp\u003eReserved for Exchange specific usage numbered above 500\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetSponsored":{"name":"sponsored","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDescription":{"name":"description","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetRating":{"name":"rating","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetLikes":{"name":"likes","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDownloads":{"name":"downloads","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetPrice":{"name":"price","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetSaleprice":{"name":"saleprice","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetPhone":{"name":"phone","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetAddress":{"name":"address","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDescription2":{"name":"description2","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDisplayurl":{"name":"displayurl","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetCtatext":{"name":"ctatext","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetCustom":{"name":"Custom","abstract":"\u003cp\u003eCustom type for user-defined data assets\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/s:12PrebidMobile9DataAssetO10exchangeIDSivp":{"name":"exchangeID","abstract":"\u003cp\u003eGets or sets the exchange ID for the asset type.\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html":{"name":"DataAsset","abstract":"\u003cp\u003eEnum representing different types of native data assets.\u003c/p\u003e"},"Enums/NativeDataAssetType.html":{"name":"NativeDataAssetType","abstract":"\u003cp\u003eEnum representing various types of native data assets that can be used in ads.\u003c/p\u003e"},"Enums/NativeImageAssetType.html":{"name":"NativeImageAssetType","abstract":"\u003cp\u003eEnum representing various types of native image assets used in ads.\u003c/p\u003e"},"Enums/Gender.html":{"name":"Gender","abstract":"\u003cp\u003eAn enumeration representing gender options for ad targeting or other purposes."},"Enums/PrebidInitializationStatus.html":{"name":"PrebidInitializationStatus","abstract":"\u003cp\u003eEnum representing the initialization status of the Prebid SDK.\u003c/p\u003e"},"Enums/PrebidHost.html":{"name":"PrebidHost","abstract":"\u003cp\u003e\u003ccode\u003ePrebidHost\u003c/code\u003e represents various Prebid server hosts used for ad bidding.\u003c/p\u003e"},"Enums/AdPosition.html":{"name":"AdPosition","abstract":"\u003cp\u003eAd position on screen. Refer to List 5.4:"},"Enums/Position.html":{"name":"Position","abstract":"\u003cp\u003eEnum representing various positions on the screen.\u003c/p\u003e"},"Enums/ResultCode.html":{"name":"ResultCode","abstract":"\u003cp\u003eEnum representing the result codes for various operations within the Prebid SDK.\u003c/p\u003e"},"Classes/MediationRewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationRewardedAdUnit(im)initWithConfigId:mediationDelegate:":{"name":"init(configId:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new instance of the \u003ccode\u003eMediationRewardedAdUnit\u003c/code\u003e with the specified configuration ID and mediation delegate.\u003c/p\u003e","parent_name":"MediationRewardedAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(py)nativeAdUnit":{"name":"nativeAdUnit","abstract":"\u003cp\u003eThe native ad unit that makes native request.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)initWithConfigId:mediationDelegate:":{"name":"init(configId:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new instance of the \u003ccode\u003eMediationNativeAdUnit\u003c/code\u003e with the specified configuration ID and mediation delegate.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addEventTracker:":{"name":"addEventTracker(_:)","abstract":"\u003cp\u003eAdds event trackers to the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addNativeAssets:":{"name":"addNativeAssets(_:)","abstract":"\u003cp\u003eAdds native assets to the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setContextType:":{"name":"setContextType(_:)","abstract":"\u003cp\u003eSets the context type for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setPlacementType:":{"name":"setPlacementType(_:)","abstract":"\u003cp\u003eSets the placement type for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setPlacementCount:":{"name":"setPlacementCount(_:)","abstract":"\u003cp\u003eSets the placement count for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setContextSubType:":{"name":"setContextSubType(_:)","abstract":"\u003cp\u003eSets the context subtype for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setSequence:":{"name":"setSequence(_:)","abstract":"\u003cp\u003eSets the sequence for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setAssetURLSupport:":{"name":"setAssetURLSupport(_:)","abstract":"\u003cp\u003eSets the asset URL support for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setDURLSupport:":{"name":"setDURLSupport(_:)","abstract":"\u003cp\u003eSets the DURL support for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setPrivacy:":{"name":"setPrivacy(_:)","abstract":"\u003cp\u003eSets the privacy value for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setExt:":{"name":"setExt(_:)","abstract":"\u003cp\u003eSets the extended data for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)getOrtbConfig":{"name":"getOrtbConfig()","abstract":"\u003cp\u003eRetrieves the OpenRTB configuration for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setOrtbConfig:":{"name":"setOrtbConfig(_:)","abstract":"\u003cp\u003eSets the OpenRTB configuration for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeAppContent:":{"name":"removeAppContent(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting.","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request for the native ad unit and setups mediation parameters.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe ad format for the ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)additionalSizes":{"name":"additionalSizes","abstract":"\u003cp\u003eAdditional sizes for the ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)skipButtonArea":{"name":"skipButtonArea","abstract":"\u003cp\u003eThe area for the skip button in the video ad.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)skipButtonPosition":{"name":"skipButtonPosition","abstract":"\u003cp\u003eThe position of the skip button in the video ad.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)skipDelay":{"name":"skipDelay","abstract":"\u003cp\u003eThe delay before the skip button appears in the video ad.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(im)initWithConfigId:mediationDelegate:":{"name":"init(configId:mediationDelegate:)","abstract":"\u003cp\u003eConvenience initializer for the mediation interstitial ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/s:12PrebidMobile27MediationInterstitialAdUnitC8configId17minSizePercentage17mediationDelegateACSS_So6CGSizeVSgAA0acM0_ptcfc":{"name":"init(configId:minSizePercentage:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new mediation interstitial ad unit with the specified configuration ID, minimum size percentage, and mediation delegate.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)configId":{"name":"configId","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eParameters for configuring banner ads.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eParameters for configuring video ads.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)isMuted":{"name":"isMuted","abstract":"\u003cp\u003eIndicates whether the video ad is muted.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)isSoundButtonVisible":{"name":"isSoundButtonVisible","abstract":"\u003cp\u003eIndicates whether the sound button is visible in the video ad.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)closeButtonArea":{"name":"closeButtonArea","abstract":"\u003cp\u003eThe area for the close button in the video ad.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)closeButtonPosition":{"name":"closeButtonPosition","abstract":"\u003cp\u003eThe position of the close button in the video ad.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eOpenRTB configuration for the ad unit.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)configId":{"name":"configId","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request and setups mediation parameters.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting.","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all content data objects from the app content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)mediationDelegate":{"name":"mediationDelegate","abstract":"\u003cp\u003eProperty that performs certain utilty work for the \u003ccode\u003eMediationBannerAdUnit\u003c/code\u003e\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)configID":{"name":"configID","abstract":"\u003cp\u003eThe configuration ID for an ad unit\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)adFormat":{"name":"adFormat","abstract":"\u003cp\u003eThe ad format for the ad unit.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)adPosition":{"name":"adPosition","abstract":"\u003cp\u003eThe position of the ad on the screen.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eParameters for configuring banner ads.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eParameters for configuring video ads.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)refreshInterval":{"name":"refreshInterval","abstract":"\u003cp\u003eThe refresh interval for the ad.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)additionalSizes":{"name":"additionalSizes","abstract":"\u003cp\u003eAdditional sizes for the ad unit.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eOpenRTB configuration\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting.","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)getAppContent":{"name":"getAppContent()","abstract":"\u003cp\u003eRetrieves the current app content object.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all content data objects from the app content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)initWithConfigID:size:mediationDelegate:":{"name":"init(configID:size:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new mediation banner ad unit with the specified configuration ID, size, and mediation delegate.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request and setups mediation parameters.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)stopRefresh":{"name":"stopRefresh()","abstract":"\u003cp\u003eStops the auto-refresh for the ad unit.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)adObjectDidFailToLoadAdWithAdObject:with:":{"name":"adObjectDidFailToLoadAd(adObject:with:)","abstract":"\u003cp\u003eHandles the event when the ad object fails to load an ad.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(py)reward":{"name":"reward","abstract":"\u003cp\u003eThe reward object for the ad unit.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)initWithConfigID:eventHandler:":{"name":"init(configID:eventHandler:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedAdUnit\u003c/code\u003e with the given configuration ID and event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)initWithConfigID:":{"name":"init(configID:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedAdUnit\u003c/code\u003e with the given configuration ID and a default event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)userDidEarnReward:":{"name":"userDidEarnReward(_:)","abstract":"\u003cp\u003eCalled when the user earns a reward.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)interstitialControllerDidCloseAd:":{"name":"interstitialControllerDidCloseAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial ad is closed.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didReceiveAd":{"name":"callDelegate_didReceiveAd()","abstract":"\u003cp\u003eCalled when the ad unit receives an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didFailToReceiveAdWith:":{"name":"callDelegate_didFailToReceiveAd(with:)","abstract":"\u003cp\u003eCalled when the ad unit fails to receive an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_willPresentAd":{"name":"callDelegate_willPresentAd()","abstract":"\u003cp\u003eCalled when the ad unit will present an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didDismissAd":{"name":"callDelegate_didDismissAd()","abstract":"\u003cp\u003eCalled when the ad unit dismisses an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_willLeaveApplication":{"name":"callDelegate_willLeaveApplication()","abstract":"\u003cp\u003eCalled when the ad unit will leave the application.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didClickAd":{"name":"callDelegate_didClickAd()","abstract":"\u003cp\u003eCalled when the ad unit is clicked.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_isReady":{"name":"callEventHandler_isReady()","abstract":"\u003cp\u003eReturns whether the event handler is ready.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_setLoadingDelegate:":{"name":"callEventHandler_setLoadingDelegate(_:)","abstract":"\u003cp\u003eSets the loading delegate for the event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_setInteractionDelegate":{"name":"callEventHandler_setInteractionDelegate()","abstract":"\u003cp\u003eSets the interaction delegate for the event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_requestAdWith:":{"name":"callEventHandler_requestAd(with:)","abstract":"\u003cp\u003eRequests an ad with the given bid response.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_showFrom:":{"name":"callEventHandler_show(from:)","abstract":"\u003cp\u003eShows the ad from the specified view controller.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_trackImpression":{"name":"callEventHandler_trackImpression()","abstract":"\u003cp\u003eTracks the impression for the ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(py)skipButtonArea":{"name":"skipButtonArea","abstract":"\u003cp\u003eThe area of the skip button in the video controls, specified as a percentage of the screen width.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(py)skipButtonPosition":{"name":"skipButtonPosition","abstract":"\u003cp\u003eThe position of the skip button in the video controls.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(py)skipDelay":{"name":"skipDelay","abstract":"\u003cp\u003eThe delay before the skip button appears, in seconds.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)initWithConfigID:":{"name":"init(configID:)","abstract":"\u003cp\u003eInitializes a new interstitial rendering ad unit with the specified configuration ID.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)initWithConfigID:minSizePercentage:":{"name":"init(configID:minSizePercentage:)","abstract":"\u003cp\u003eInitializes a new interstitial rendering ad unit with the specified configuration ID and minimum size percentage.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)initWithConfigID:minSizePercentage:eventHandler:":{"name":"init(configID:minSizePercentage:eventHandler:)","abstract":"\u003cp\u003eInitializes a new interstitial rendering ad unit with the specified configuration ID, minimum size percentage, and event handler.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didReceiveAd":{"name":"callDelegate_didReceiveAd()","abstract":"\u003cp\u003eCalled when an ad is successfully received.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didFailToReceiveAdWith:":{"name":"callDelegate_didFailToReceiveAd(with:)","abstract":"\u003cp\u003eCalled when the ad fails to be received.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_willPresentAd":{"name":"callDelegate_willPresentAd()","abstract":"\u003cp\u003eCalled when the ad will be presented.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didDismissAd":{"name":"callDelegate_didDismissAd()","abstract":"\u003cp\u003eCalled when the ad is dismissed.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_willLeaveApplication":{"name":"callDelegate_willLeaveApplication()","abstract":"\u003cp\u003eCalled when the user will leave the application.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didClickAd":{"name":"callDelegate_didClickAd()","abstract":"\u003cp\u003eCalled when the ad is clicked.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_isReady":{"name":"callEventHandler_isReady()","abstract":"\u003cp\u003eChecks if the ad is ready to be displayed.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_setLoadingDelegate:":{"name":"callEventHandler_setLoadingDelegate(_:)","abstract":"\u003cp\u003eSets the loading delegate for the event handler.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_setInteractionDelegate":{"name":"callEventHandler_setInteractionDelegate()","abstract":"\u003cp\u003eSets the interaction delegate for the event handler.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_requestAdWith:":{"name":"callEventHandler_requestAd(with:)","abstract":"\u003cp\u003eRequests an ad with the specified bid response\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_showFrom:":{"name":"callEventHandler_show(from:)","abstract":"\u003cp\u003eShows the ad from the specified view controller.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_trackImpression":{"name":"callEventHandler_trackImpression()","abstract":"\u003cp\u003eTracks an impression for the ad.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eThe banner parameters used for configuring ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video parameters used for configuring ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)lastBidResponse":{"name":"lastBidResponse","abstract":"\u003cp\u003eThe last bid response received for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)configID":{"name":"configID","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe set of ad formats supported by this ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eThe ORTB (OpenRTB) configuration string for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)isReady":{"name":"isReady","abstract":"\u003cp\u003eA Boolean value indicating whether the ad unit is ready to be displayed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)isMuted":{"name":"isMuted","abstract":"\u003cp\u003eA Boolean value indicating whether the video controls are muted.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)isSoundButtonVisible":{"name":"isSoundButtonVisible","abstract":"\u003cp\u003eA Boolean value indicating whether the sound button is visible in the video controls.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)closeButtonArea":{"name":"closeButtonArea","abstract":"\u003cp\u003eThe area of the close button in the video controls as a percentage.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)closeButtonPosition":{"name":"closeButtonPosition","abstract":"\u003cp\u003eThe position of the close button in the video controls.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eA delegate for handling interactions with the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)adUnitConfig":{"name":"adUnitConfig","abstract":"\u003cp\u003eThe configuration object for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID11minSizePerc12eventHandlerACSS_So7NSValueCSgyXlSgtcfc":{"name":"init(configID:minSizePerc:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID, minimum size percentage, and event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID17minSizePercentage12eventHandlerACSS_So6CGSizeVyXlSgtcfc":{"name":"init(configID:minSizePercentage:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID, minimum size percentage, and event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID12eventHandlerACSS_yXlSgtcfc":{"name":"init(configID:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID and event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID17minSizePercentageACSS_So6CGSizeVtcfc":{"name":"init(configID:minSizePercentage:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID and minimum size percentage.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configIDACSS_tcfc":{"name":"init(configID:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)loadAd":{"name":"loadAd()","abstract":"\u003cp\u003eLoads a new ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)showFrom:":{"name":"show(from:)","abstract":"\u003cp\u003eShows the ad from a specified view controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addContextData:forKey:":{"name":"addContextData(_:forKey:)","abstract":"\u003cp\u003eAdds context data for a specified key.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)updateContextData:forKey:":{"name":"updateContextData(_:forKey:)","abstract":"\u003cp\u003eUpdates context data for a specified key.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeContextDateForKey:":{"name":"removeContextDate(forKey:)","abstract":"\u003cp\u003eRemoves context data for a specified key.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eClears all context data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eAdds ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eUpdates ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eRemoves ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eClears ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eAdds a context keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eAdds a set of context keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eRemoves a context keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eClears all context keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eAdds an extended keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eAdds multiple extended keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eRemoves an extended keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eClears all extended keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the app content data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds app content data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeAppContentDataObject:":{"name":"removeAppContentDataObject(_:)","abstract":"\u003cp\u003eRemoves an app content data object.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearAppContentDataObjects":{"name":"clearAppContentDataObjects()","abstract":"\u003cp\u003eClears all app content data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds user data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a user data object.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialAdLoader:loadedAd:isReadyBlock:":{"name":"interstitialAdLoader(_:loadedAd:isReadyBlock:)","abstract":"\u003cp\u003eInternal delegate method.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialAdLoader:createdInterstitialController:":{"name":"interstitialAdLoader(_:createdInterstitialController:)","abstract":"\u003cp\u003eInternal delegate method.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)eventHandler":{"name":"eventHandler","abstract":"\u003cp\u003eThe event handler for the interstitial events.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowControllerWillSendBidRequest:":{"name":"adLoadFlowControllerWillSendBidRequest(_:)","abstract":"\u003cp\u003eCalled when the ad load flow controller is about to send a bid request.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowControllerWillRequestPrimaryAd:":{"name":"adLoadFlowControllerWillRequestPrimaryAd(_:)","abstract":"\u003cp\u003eCalled when the ad load flow controller is about to request the primary ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowControllerShouldContinue:":{"name":"adLoadFlowControllerShouldContinue(_:)","abstract":"\u003cp\u003eCalled to determine if the ad load flow controller should continue with the current flow.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowController:failedWithError:":{"name":"adLoadFlowController(_:failedWithError:)","abstract":"\u003cp\u003eCalled when the ad load flow controller fails with an error.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)trackImpressionForInterstitialController:":{"name":"trackImpression(forInterstitialController:)","abstract":"\u003cp\u003eTracks an impression for the given interstitial controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidClickAd:":{"name":"interstitialControllerDidClickAd(_:)","abstract":"\u003cp\u003eCalled when the ad in the interstitial controller is clicked.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidCloseAd:":{"name":"interstitialControllerDidCloseAd(_:)","abstract":"\u003cp\u003eCalled when the ad in the interstitial controller is closed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidLeaveApp:":{"name":"interstitialControllerDidLeaveApp(_:)","abstract":"\u003cp\u003eCalled when the ad in the interstitial controller causes the app to leave.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidDisplay:":{"name":"interstitialControllerDidDisplay(_:)","abstract":"\u003cp\u003eCalled when the interstitial controller displays an ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidComplete:":{"name":"interstitialControllerDidComplete(_:)","abstract":"\u003cp\u003eCalled when the interstitial controller completes the ad display.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)viewControllerForModalPresentationFromInterstitialController:":{"name":"viewControllerForModalPresentation(fromInterstitialController:)","abstract":"\u003cp\u003eProvides the view controller to use for modal presentation.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)willPresentAd":{"name":"willPresentAd()","abstract":"\u003cp\u003eCalled when an ad is about to be presented.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)didDismissAd":{"name":"didDismissAd()","abstract":"\u003cp\u003eCalled when an ad has been dismissed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)willLeaveApp":{"name":"willLeaveApp()","abstract":"\u003cp\u003eCalled when the ad causes the app to leave.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)didClickAd":{"name":"didClickAd()","abstract":"\u003cp\u003eCalled when an ad is clicked.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_requestAdWith:":{"name":"callEventHandler_requestAd(with:)","abstract":"\u003cp\u003eRequests an ad using the provided bid response.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_showFrom:":{"name":"callEventHandler_show(from:)","abstract":"\u003cp\u003eDisplays the ad using the provided view controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_isReady":{"name":"callEventHandler_isReady()","abstract":"\u003cp\u003eChecks if the ad unit is ready to show an ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didReceiveAd":{"name":"callDelegate_didReceiveAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad has been successfully received.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didFailToReceiveAdWith:":{"name":"callDelegate_didFailToReceiveAd(with:)","abstract":"\u003cp\u003eNotifies the delegate that the ad failed to load.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_willPresentAd":{"name":"callDelegate_willPresentAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad is about to be presented.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didDismissAd":{"name":"callDelegate_didDismissAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad has been dismissed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_willLeaveApplication":{"name":"callDelegate_willLeaveApplication()","abstract":"\u003cp\u003eNotifies the delegate that the app is about to leave due to an ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didClickAd":{"name":"callDelegate_didClickAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad has been clicked.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_setLoadingDelegate:":{"name":"callEventHandler_setLoadingDelegate(_:)","abstract":"\u003cp\u003eSets the loading delegate for the event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_setInteractionDelegate":{"name":"callEventHandler_setInteractionDelegate()","abstract":"\u003cp\u003eSets the interaction delegate for the event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC39callEventHandler_showFromViewController10controllerySo06UIViewM0CSg_tF":{"name":"callEventHandler_showFromViewController(controller:)","abstract":"\u003cp\u003eShows the ad from the provided view controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_trackImpression":{"name":"callEventHandler_trackImpression()","abstract":"\u003cp\u003eTracks an impression for the ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)adUnitConfig":{"name":"adUnitConfig","abstract":"\u003cp\u003eThe ad unit configuration.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)eventHandler":{"name":"eventHandler","abstract":"\u003cp\u003eThe event handler for banner view events.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eBanner-specific parameters.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eVideo-specific parameters.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)lastBidResponse":{"name":"lastBidResponse","abstract":"\u003cp\u003eThe last bid response received.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)configID":{"name":"configID","abstract":"\u003cp\u003eID of Stored Impression on the Prebid server\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)refreshInterval":{"name":"refreshInterval","abstract":"\u003cp\u003eThe interval for refreshing the ad.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)additionalSizes":{"name":"additionalSizes","abstract":"\u003cp\u003eAdditional sizes for the ad.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)adFormat":{"name":"adFormat","abstract":"\u003cp\u003eThe ad format (e.g., banner, video).\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)adPosition":{"name":"adPosition","abstract":"\u003cp\u003eThe position of the ad on the screen.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eORTB configuration string.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)initWithFrame:configID:adSize:eventHandler:":{"name":"init(frame:configID:adSize:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBannerView\u003c/code\u003e.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)initWithConfigID:eventHandler:":{"name":"init(configID:eventHandler:)","abstract":"\u003cp\u003eConvenience initializer for creating a \u003ccode\u003eBannerView\u003c/code\u003e with a configuration ID and event handler.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)initWithFrame:configID:adSize:":{"name":"init(frame:configID:adSize:)","abstract":"\u003cp\u003eConvenience initializer for creating a \u003ccode\u003eBannerView\u003c/code\u003e with a frame, configuration ID, and ad size.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)loadAd":{"name":"loadAd()","abstract":"\u003cp\u003eLoads the ad for the banner view.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)setStoredAuctionResponseWithStoredAuction:":{"name":"setStoredAuctionResponse(storedAuction:)","abstract":"\u003cp\u003eSets the stored auction response.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)stopRefresh":{"name":"stopRefresh()","abstract":"\u003cp\u003eStops the auto-refresh of the ad.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addContextData:forKey:":{"name":"addContextData(_:forKey:)","abstract":"\u003cp\u003eAdds context data for a specified key.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)updateContextData:forKey:":{"name":"updateContextData(_:forKey:)","abstract":"\u003cp\u003eUpdates context data for a specified key.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeContextDateForKey:":{"name":"removeContextDate(forKey:)","abstract":"\u003cp\u003eRemoves context data for a specified key.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eClears all context data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eAdds ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eUpdates ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eRemoves ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eClears ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eAdds a context keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eAdds a set of context keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eRemoves a context keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eClears all context keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eAdds an extended keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eAdds multiple extended keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eRemoves an extended keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eClears all extended keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the app content data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds app content data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeAppContentDataObject:":{"name":"removeAppContentDataObject(_:)","abstract":"\u003cp\u003eRemoves an app content data object.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearAppContentDataObjects":{"name":"clearAppContentDataObjects()","abstract":"\u003cp\u003eClears all app content data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds user data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a user data object.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)trackImpressionForDisplayView:":{"name":"trackImpression(forDisplayView:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)viewControllerForModalPresentationFromDisplayView:":{"name":"viewControllerForModalPresentation(fromDisplayView:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)didLeaveAppFrom:":{"name":"didLeaveApp(from:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)willPresentModalFrom:":{"name":"willPresentModal(from:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)didDismissModalFrom:":{"name":"didDismissModal(from:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)bannerAdLoader:loadedAdView:adSize:":{"name":"bannerAdLoader(_:loadedAdView:adSize:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)bannerAdLoader:createdDisplayView:":{"name":"bannerAdLoader(_:createdDisplayView:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowController:failedWithError:":{"name":"adLoadFlowController(_:failedWithError:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowControllerWillSendBidRequest:":{"name":"adLoadFlowControllerWillSendBidRequest(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowControllerWillRequestPrimaryAd:":{"name":"adLoadFlowControllerWillRequestPrimaryAd(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowControllerShouldContinue:":{"name":"adLoadFlowControllerShouldContinue(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)willPresentModal":{"name":"willPresentModal()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)didDismissModal":{"name":"didDismissModal()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)willLeaveApp":{"name":"willLeaveApp()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)viewControllerForPresentingModal":{"name":"viewControllerForPresentingModal","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)maxVideoDuration":{"name":"maxVideoDuration","abstract":"\u003cp\u003eThis property indicates maximum video duration.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)isMuted":{"name":"isMuted","abstract":"\u003cp\u003eThis property indicates whether the ad should run playback with sound or not.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)closeButtonArea":{"name":"closeButtonArea","abstract":"\u003cp\u003eThis property indicates the area which the close button should occupy on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)closeButtonPosition":{"name":"closeButtonPosition","abstract":"\u003cp\u003eThis property indicates the position of the close button on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)skipButtonArea":{"name":"skipButtonArea","abstract":"\u003cp\u003eThis property indicates the area which the skip button should occupy on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)skipButtonPosition":{"name":"skipButtonPosition","abstract":"\u003cp\u003eThis property indicates the position of the skip button on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)skipDelay":{"name":"skipDelay","abstract":"\u003cp\u003eThis property indicates the number of seconds which should be passed from the start of playback until the skip or close button should be shown.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)isSoundButtonVisible":{"name":"isSoundButtonVisible","abstract":"\u003cp\u003eThis property indicates whether mute controls is visible on the screen.\u003c/p\u003e","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(im)initializeWith:":{"name":"initialize(with:)","abstract":"\u003cp\u003eUse to initialize video controls with server values.\u003c/p\u003e","parent_name":"VideoControlsConfiguration"},"Classes/AdFormat.html#/s:12PrebidMobile8AdFormatC8RawValuea":{"name":"RawValue","abstract":"\u003cp\u003eThe underlying type of the raw value.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(py)rawValue":{"name":"rawValue","abstract":"\u003cp\u003eThe raw integer value representing the ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(py)stringEquivalent":{"name":"stringEquivalent","abstract":"\u003cp\u003eThe string representation of the ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(im)initWithRawValue:stringEquivalent:":{"name":"init(rawValue:stringEquivalent:)","abstract":"\u003cp\u003eInitializes an \u003ccode\u003eAdFormat\u003c/code\u003e instance with a specified raw value and its string equivalent.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(im)initWithRawValue:":{"name":"init(rawValue:)","abstract":"\u003cp\u003eInitializes an \u003ccode\u003eAdFormat\u003c/code\u003e instance with a specified raw value.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)banner":{"name":"banner","abstract":"\u003cp\u003eRepresents a banner ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)video":{"name":"video","abstract":"\u003cp\u003eRepresents a video ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)native":{"name":"native","abstract":"\u003cp\u003eRepresents a native ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)display":{"name":"display","abstract":"\u003cp\u003eRepresents a deprecated display ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)allCases":{"name":"allCases","abstract":"\u003cp\u003eAn array containing all cases of ad formats, excluding deprecated ones.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eThe class is created as a singleton object \u0026amp; used\u003c/p\u003e","parent_name":"Host"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(im)setCustomHostURL:error:":{"name":"setCustomHostURL(_:)","abstract":"\u003cp\u003eThe CustomHost property holds the URL for the custom prebid adaptor\u003c/p\u003e","parent_name":"Host"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(im)getHostURLWithHost:error:":{"name":"getHostURL(host:)","abstract":"\u003cp\u003eThis function retrieves the prebid server URL for the selected host\u003c/p\u003e","parent_name":"Host"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(im)verifyUrlWithUrlString:":{"name":"verifyUrl(urlString:)","abstract":"\u003cp\u003eThis function verifies if the prebid server URL is in the url format\u003c/p\u003e","parent_name":"Host"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(cpy)supportsSecureCoding":{"name":"supportsSecureCoding","abstract":"\u003cp\u003eIndicates whether the class supports secure coding.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)source":{"name":"source","abstract":"\u003cp\u003eThe source of the external user ID.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)identifier":{"name":"identifier","abstract":"\u003cp\u003eThe identifier of the external user ID.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)atype":{"name":"atype","abstract":"\u003cp\u003eThe type of the external user ID, represented as an optional \u003ccode\u003eNSNumber\u003c/code\u003e.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional attributes related to the external user ID, represented as an optional dictionary.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)initWithSource:identifier:atype:ext:":{"name":"init(source:identifier:atype:ext:)","abstract":"\u003cp\u003eInitialize ExternalUserId Class\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)encodeWithCoder:":{"name":"encode(with:)","abstract":"\u003cp\u003eEncodes the properties of the class using the given encoder.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)initWithCoder:":{"name":"init(coder:)","abstract":"\u003cp\u003eInitializes an \u003ccode\u003eExternalUserId\u003c/code\u003e instance from the given decoder.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)toJSONDictionary":{"name":"toJSONDictionary()","abstract":"\u003cp\u003eConverts the \u003ccode\u003eExternalUserId\u003c/code\u003e instance to a JSON dictionary.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eA shared instance of the \u003ccode\u003eTargeting\u003c/code\u003e class.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)omidPartnerName":{"name":"omidPartnerName","abstract":"\u003cp\u003eThe name of the OMID partner.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)omidPartnerVersion":{"name":"omidPartnerVersion","abstract":"\u003cp\u003eThe version of the OMID partner.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)yearOfBirth":{"name":"yearOfBirth","abstract":"\u003cp\u003eIndicates user birth year.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setYearOfBirthWithYob:":{"name":"setYearOfBirth(yob:)","abstract":"\u003cp\u003eThis method set the year of birth value\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getYearOfBirth":{"name":"getYearOfBirth()","abstract":"\u003cp\u003eObjective C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearYearOfBirth":{"name":"clearYearOfBirth()","abstract":"\u003cp\u003eThis method clears year of birth value set by the application developer\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userGender":{"name":"userGender","abstract":"\u003cp\u003eIndicates the end-user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)userGenderDescription":{"name":"userGenderDescription()","abstract":"\u003cp\u003eString representation of the users gender,","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userID":{"name":"userID","abstract":"\u003cp\u003eIndicates the customer-provided user ID, if different from the Device ID.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)buyerUID":{"name":"buyerUID","abstract":"\u003cp\u003eBuyer-specific ID for the user as mapped by the exchange for the buyer.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userCustomData":{"name":"userCustomData","abstract":"\u003cp\u003eOptional feature to pass bidder data that was set in the","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)eids":{"name":"eids","abstract":"\u003cp\u003ePlaceholder for User Identity Links.","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userExt":{"name":"userExt","abstract":"\u003cp\u003ePlaceholder for exchange-specific extensions to OpenRTB.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)coppa":{"name":"coppa","abstract":"\u003cp\u003eObjective C analog of subjectToCOPPA\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC14subjectToCOPPASbSgvp":{"name":"subjectToCOPPA","abstract":"\u003cp\u003eInteger flag indicating if this request is subject to the COPPA regulations","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC13subjectToGDPRSbSgvp":{"name":"subjectToGDPR","abstract":"\u003cp\u003eThe boolean value set by the user to collect user data\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setSubjectToGDPR:":{"name":"setSubjectToGDPR(_:)","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getSubjectToGDPR":{"name":"getSubjectToGDPR()","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)gdprConsentString":{"name":"gdprConsentString","abstract":"\u003cp\u003eThe consent string for sending the GDPR consent\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)purposeConsents":{"name":"purposeConsents","abstract":"\u003cp\u003eThe consent string for purposes consent as per TCFv2.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC22getDeviceAccessConsentSbSgyF":{"name":"getDeviceAccessConsent()","abstract":"\u003cp\u003ePurpose 1 - Store and/or access information on a device\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getDeviceAccessConsentObjc":{"name":"getDeviceAccessConsentObjc()","abstract":"\u003cp\u003eReturns whether the user has consented to access device data as an \u003ccode\u003eNSNumber\u003c/code\u003e.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC17getPurposeConsent5indexSbSgSi_tF":{"name":"getPurposeConsent(index:)","abstract":"\u003cp\u003eReturns the user\u0026rsquo;s consent for a specific purpose by index.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)isAllowedAccessDeviceData":{"name":"isAllowedAccessDeviceData()","abstract":"\u003cp\u003eChecks if access to device data is allowed.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)externalUserIds":{"name":"externalUserIds","abstract":"\u003cp\u003eArray of external user IDs.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)storeExternalUserId:":{"name":"storeExternalUserId(_:)","abstract":"\u003cp\u003eThis method allows to save External User Id in the User Defaults\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)fetchStoredExternalUserIds":{"name":"fetchStoredExternalUserIds()","abstract":"\u003cp\u003eThis method allows to get All External User Ids from User Defaults\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)fetchStoredExternalUserId:":{"name":"fetchStoredExternalUserId(_:)","abstract":"\u003cp\u003eThis method allows to get External User Id from User Defaults by passing respective \u0026lsquo;source\u0026rsquo; string as param\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeStoredExternalUserId:":{"name":"removeStoredExternalUserId(_:)","abstract":"\u003cp\u003eThis method allows to remove specific External User Id from User Defaults by passing respective \u0026lsquo;source\u0026rsquo; string as param\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeStoredExternalUserIds":{"name":"removeStoredExternalUserIds()","abstract":"\u003cp\u003eThis method allows to remove all the External User Ids from User Defaults\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getExternalUserIds":{"name":"getExternalUserIds()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)contentUrl":{"name":"contentUrl","abstract":"\u003cp\u003eThis is the deep-link URL for the app screen that is displaying the ad. This can be an iOS universal link.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)publisherName":{"name":"publisherName","abstract":"\u003cp\u003eApp\u0026rsquo;s publisher name.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)sourceapp":{"name":"sourceapp","abstract":"\u003cp\u003eID of publisher app in Apple’s App Store.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)storeURL":{"name":"storeURL","abstract":"\u003cp\u003eApp store URL for an installed app\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)domain":{"name":"domain","abstract":"\u003cp\u003eDomain name of the app\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)itunesID":{"name":"itunesID","abstract":"\u003cp\u003eThe itunes app id for targeting\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)location":{"name":"location","abstract":"\u003cp\u003eThe application location for targeting\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC17locationPrecisionSiSgvp":{"name":"locationPrecision","abstract":"\u003cp\u003eThe application location precision for targeting\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setLocationPrecision:":{"name":"setLocationPrecision(_:)","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getLocationPrecision":{"name":"getLocationPrecision()","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)coordinate":{"name":"coordinate","abstract":"\u003cp\u003eCLLocationCoordinate2D.","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addParam:withName:":{"name":"addParam(_:withName:)","abstract":"\u003cp\u003eAdds a parameter to the parameter dictionary with a specified name.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setCustomParams:":{"name":"setCustomParams(_:)","abstract":"\u003cp\u003eSets custom parameters by adding each key-value pair to the parameter dictionary.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addCustomParam:withName:":{"name":"addCustomParam(_:withName:)","abstract":"\u003cp\u003eAdds a custom parameter to the parameter dictionary with a prefixed name.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setLatitude:longitude:":{"name":"setLatitude(_:longitude:)","abstract":"\u003cp\u003eStore location in the user\u0026rsquo;s section\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addBidderToAccessControlList:":{"name":"addBidderToAccessControlList(_:)","abstract":"\u003cp\u003eAdds a bidder to the access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeBidderFromAccessControlList:":{"name":"removeBidderFromAccessControlList(_:)","abstract":"\u003cp\u003eRemoves a bidder from the access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearAccessControlList":{"name":"clearAccessControlList()","abstract":"\u003cp\u003eClears all bidders from the access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getAccessControlList":{"name":"getAccessControlList()","abstract":"\u003cp\u003eRetrieves the current access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)accessControlList":{"name":"accessControlList","abstract":"\u003cp\u003eAccess control list for external use.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addUserDataWithKey:value:":{"name":"addUserData(key:value:)","abstract":"\u003cp\u003eAdds user data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)updateUserDataWithKey:value:":{"name":"updateUserData(key:value:)","abstract":"\u003cp\u003eUpdates user data for a specified key with a new set of values.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeUserDataFor:":{"name":"removeUserData(for:)","abstract":"\u003cp\u003eRemoves user data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getUserData":{"name":"getUserData()","abstract":"\u003cp\u003eRetrieves all user data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userDataDictionary":{"name":"userDataDictionary","abstract":"\u003cp\u003eUser data dictionary for external use.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addUserKeyword:":{"name":"addUserKeyword(_:)","abstract":"\u003cp\u003eAdds a user keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addUserKeywords:":{"name":"addUserKeywords(_:)","abstract":"\u003cp\u003eAdds multiple user keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeUserKeyword:":{"name":"removeUserKeyword(_:)","abstract":"\u003cp\u003eRemoves a user keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearUserKeywords":{"name":"clearUserKeywords()","abstract":"\u003cp\u003eClears all user keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getUserKeywords":{"name":"getUserKeywords()","abstract":"\u003cp\u003eRetrieves all user keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userKeywords":{"name":"userKeywords","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetUserKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eaddAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eupdateAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeContextDataFor:":{"name":"removeContextData(for:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eremoveAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eclearAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getContextData":{"name":"getContextData()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)contextDataDictionary":{"name":"contextDataDictionary","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addAppExtDataWithKey:value:":{"name":"addAppExtData(key:value:)","abstract":"\u003cp\u003eAdds application-specific data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)updateAppExtDataWithKey:value:":{"name":"updateAppExtData(key:value:)","abstract":"\u003cp\u003eUpdates application-specific data for a specified key with a new set of values.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeAppExtDataFor:":{"name":"removeAppExtData(for:)","abstract":"\u003cp\u003eRemoves application-specific data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearAppExtData":{"name":"clearAppExtData()","abstract":"\u003cp\u003eClears all application-specific data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getAppExtData":{"name":"getAppExtData()","abstract":"\u003cp\u003eRetrieves all application-specific data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eaddAppKeyword\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eaddAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eremoveAppKeyword\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eclearAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getContextKeywords":{"name":"getContextKeywords()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)contextKeywords":{"name":"contextKeywords","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addAppKeyword:":{"name":"addAppKeyword(_:)","abstract":"\u003cp\u003eAdds an application keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addAppKeywords:":{"name":"addAppKeywords(_:)","abstract":"\u003cp\u003eAdds multiple application keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeAppKeyword:":{"name":"removeAppKeyword(_:)","abstract":"\u003cp\u003eRemoves an application keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearAppKeywords":{"name":"clearAppKeywords()","abstract":"\u003cp\u003eClears all application keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getAppKeywords":{"name":"getAppKeywords()","abstract":"\u003cp\u003eRetrieves all application keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)parameterDictionary":{"name":"parameterDictionary","abstract":"\u003cp\u003eDictionary of parameters.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cpy)bidderNameAppNexus":{"name":"bidderNameAppNexus","abstract":"\u003cp\u003eThe name of the bidder for AppNexus.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cpy)bidderNameRubiconProject":{"name":"bidderNameRubiconProject","abstract":"\u003cp\u003eThe name of the bidder for Rubicon Project.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)timeoutUpdated":{"name":"timeoutUpdated","abstract":"\u003cp\u003eIndicates whether the timeout value has been updated.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)prebidServerAccountId":{"name":"prebidServerAccountId","abstract":"\u003cp\u003eThe Prebid Server account ID.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)pbsDebug":{"name":"pbsDebug","abstract":"\u003cp\u003eEnables or disables debug mode.","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)customHeaders":{"name":"customHeaders","abstract":"\u003cp\u003eCustom HTTP headers to be sent with requests.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)storedBidResponses":{"name":"storedBidResponses","abstract":"\u003cp\u003eStored bid responses identified by bidder names.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)shouldAssignNativeAssetID":{"name":"shouldAssignNativeAssetID","abstract":"\u003cp\u003eThis property is set by the developer when he is willing to assign the assetID for Native ad.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)shareGeoLocation":{"name":"shareGeoLocation","abstract":"\u003cp\u003eThis property is set by the developer when he is willing to share the location for better ad targeting\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)logLevel":{"name":"logLevel","abstract":"\u003cp\u003eSet the desidered verbosity of the logs\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)externalUserIdArray":{"name":"externalUserIdArray","abstract":"\u003cp\u003eArray containing objects that hold External UserId parameters.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eThe singleton instance of the \u003ccode\u003ePrebid\u003c/code\u003e class.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)version":{"name":"version","abstract":"\u003cp\u003eThe version of the PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)omsdkVersion":{"name":"omsdkVersion","abstract":"\u003cp\u003eThe version of the OM SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)prebidServerHost":{"name":"prebidServerHost","abstract":"\u003cp\u003eThe host for the Prebid Server.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)customStatusEndpoint":{"name":"customStatusEndpoint","abstract":"\u003cp\u003eCustom status endpoint for the Prebid Server.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)timeoutMillis":{"name":"timeoutMillis","abstract":"\u003cp\u003eTimeout for Prebid requests in milliseconds.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)timeoutMillisDynamic":{"name":"timeoutMillisDynamic","abstract":"\u003cp\u003eDynamic timeout value.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)storedAuctionResponse":{"name":"storedAuctionResponse","abstract":"\u003cp\u003eStored auction response.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)useCacheForReportingWithRenderingAPI":{"name":"useCacheForReportingWithRenderingAPI","abstract":"\u003cp\u003eIndicates whether the PBS should cache the bid for the rendering API.","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)creativeFactoryTimeout":{"name":"creativeFactoryTimeout","abstract":"\u003cp\u003eControls how long each creative has to load before it is considered a failure.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)creativeFactoryTimeoutPreRenderContent":{"name":"creativeFactoryTimeoutPreRenderContent","abstract":"\u003cp\u003eControls how long video and interstitial creatives have to load before it is considered a failure.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)useExternalClickthroughBrowser":{"name":"useExternalClickthroughBrowser","abstract":"\u003cp\u003eControls whether to use PrebidMobile\u0026rsquo;s in-app browser or the Safari App for displaying ad clickthrough content.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)impClickbrowserType":{"name":"impClickbrowserType","abstract":"\u003cp\u003eIndicates the type of browser opened upon clicking the creative in an app, where embedded = 0, native = 1.","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)debugLogFileEnabled":{"name":"debugLogFileEnabled","abstract":"\u003cp\u003eIf set to true, the output of PrebidMobile\u0026rsquo;s internal logger is written to a text file. This can be helpful for debugging. Defaults to false.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)locationUpdatesEnabled":{"name":"locationUpdatesEnabled","abstract":"\u003cp\u003eIf true, the SDK will periodically try to listen for location updates in order to request location-based ads.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)includeWinners":{"name":"includeWinners","abstract":"\u003cp\u003eIf true, the sdk will add \u003ccode\u003eincludewinners\u003c/code\u003e flag inside the targeting object described in \u003ca href=\"https://docs.prebid.org/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#targeting\"\u003ePBS Documentation\u003c/a\u003e\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)includeBidderKeys":{"name":"includeBidderKeys","abstract":"\u003cp\u003eIf true, the sdk will add \u003ccode\u003eincludebidderkeys\u003c/code\u003e flag inside the targeting object described in \u003ca href=\"https://docs.prebid.org/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#targeting\"\u003ePBS Documentation\u003c/a\u003e\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)setCustomPrebidServerWithUrl:error:":{"name":"setCustomPrebidServer(url:)","abstract":"\u003cp\u003eSets a custom Prebid Server URL.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)addStoredBidResponseWithBidder:responseId:":{"name":"addStoredBidResponse(bidder:responseId:)","abstract":"\u003cp\u003eAdds a stored bid response.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)clearStoredBidResponses":{"name":"clearStoredBidResponses()","abstract":"\u003cp\u003eClears all stored bid responses.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)getStoredBidResponses":{"name":"getStoredBidResponses()","abstract":"\u003cp\u003eRetrieves stored bid responses.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)addCustomHeaderWithName:value:":{"name":"addCustomHeader(name:value:)","abstract":"\u003cp\u003eAdds a custom HTTP header.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)clearCustomHeaders":{"name":"clearCustomHeaders()","abstract":"\u003cp\u003eClears all custom HTTP headers.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cm)initializeSDK::":{"name":"initializeSDK(_:_:)","abstract":"\u003cp\u003eInitializes PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cm)initializeSDKWithGadMobileAdsVersion::":{"name":"initializeSDK(gadMobileAdsVersion:_:)","abstract":"\u003cp\u003eInitializes PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cm)initializeSDK:":{"name":"initializeSDK(_:)","abstract":"\u003cp\u003eInitializes PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/VideoInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoInterstitialAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eThe video parameters for this ad unit.","parent_name":"VideoInterstitialAdUnit"},"Classes/VideoInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoInterstitialAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eVideoInterstitialAdUnit\u003c/code\u003e with the specified configuration ID.","parent_name":"VideoInterstitialAdUnit"},"Classes/VideoInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoInterstitialAdUnit(im)initWithConfigId:minWidthPerc:minHeightPerc:":{"name":"init(configId:minWidthPerc:minHeightPerc:)","abstract":"\u003cp\u003eConvenience initializer to create a video interstitial ad unit with specified minimum width and height percentages.\u003c/p\u003e","parent_name":"VideoInterstitialAdUnit"},"Classes/VideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eThe parameters for video ads associated with this ad unit.\u003c/p\u003e","parent_name":"VideoAdUnit"},"Classes/VideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoAdUnit(im)initWithConfigId:size:":{"name":"init(configId:size:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eVideoAdUnit\u003c/code\u003e with the specified configuration ID and size.\u003c/p\u003e","parent_name":"VideoAdUnit"},"Classes/VideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoAdUnit(im)addAdditionalSizeWithSizes:":{"name":"addAdditionalSize(sizes:)","abstract":"\u003cp\u003eAdds additional sizes to the ad unit.\u003c/p\u003e","parent_name":"VideoAdUnit"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eThe class is created as a singleton object \u0026amp; used\u003c/p\u003e","parent_name":"Utils"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eA delegate to handle native ad events.\u003c/p\u003e","parent_name":"Utils"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(im)convertDictToMoPubKeywordsWithDict:":{"name":"convertDictToMoPubKeywords(dict:)","abstract":"\u003cp\u003eDeprecated. MoPub is not available anymore. Use Prebid MAX adapters instead.\u003c/p\u003e","parent_name":"Utils"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(im)findNativeWithAdObject:":{"name":"findNative(adObject:)","abstract":"\u003cp\u003eFinds a native ad object within a given object.\u003c/p\u003e","parent_name":"Utils"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eDeprecated property for video parameters.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eProperty for video parameters.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedVideoAdUnit\u003c/code\u003e with the given configuration ID.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(im)initWithConfigId:minWidthPerc:minHeightPerc:":{"name":"init(configId:minWidthPerc:minHeightPerc:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedVideoAdUnit\u003c/code\u003e with the given configuration ID and minimum size percentages.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)api":{"name":"api","abstract":"\u003cp\u003eList of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)maxBitrate":{"name":"maxBitrate","abstract":"\u003cp\u003eMaximum bit rate in Kbps.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)minBitrate":{"name":"minBitrate","abstract":"\u003cp\u003eMaximum bit rate in Kbps.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)maxDuration":{"name":"maxDuration","abstract":"\u003cp\u003eMaximum video ad duration in seconds.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)minDuration":{"name":"minDuration","abstract":"\u003cp\u003eMinimum video ad duration in seconds.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)mimes":{"name":"mimes","abstract":"\u003cp\u003eContent MIME types supported.","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)playbackMethod":{"name":"playbackMethod","abstract":"\u003cp\u003eAllowed playback methods. If none specified, assume all are allowed.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)protocols":{"name":"protocols","abstract":"\u003cp\u003eArray of supported video bid response protocols.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)startDelay":{"name":"startDelay","abstract":"\u003cp\u003eIndicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)placement":{"name":"placement","abstract":"\u003cp\u003ePlacement type for the impression.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)linearity":{"name":"linearity","abstract":"\u003cp\u003eIndicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/s:12PrebidMobile15VideoParametersC6adSizeSo6CGSizeVSgvp":{"name":"adSize","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)rawAPI":{"name":"rawAPI","abstract":"\u003cp\u003eHelper property\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)rawPlaybackMethod":{"name":"rawPlaybackMethod","abstract":"\u003cp\u003eHelper property\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)rawProtocols":{"name":"rawProtocols","abstract":"\u003cp\u003eHelper property\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(im)initWithMimes:":{"name":"init(mimes:)","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(im)setSize:":{"name":"setSize(_:)","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/SingleContainerInt.html#/s:s27ExpressibleByIntegerLiteralP0cD4TypeQa":{"name":"IntegerLiteralType","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/c:@M@PrebidMobile@objc(cs)SingleContainerInt(py)value":{"name":"value","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/s:s27ExpressibleByIntegerLiteralP07integerD0x0cD4TypeQz_tcfc":{"name":"init(integerLiteral:)","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/c:@M@PrebidMobile@objc(cs)SingleContainerInt(im)isEqual:":{"name":"isEqual(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/c:@M@PrebidMobile@objc(cs)SingleContainerInt(py)hash":{"name":"hash","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"SingleContainerInt"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC8InStreamAEvpZ":{"name":"InStream","abstract":"\u003cp\u003eIn-Stream\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC8InBannerAEvpZ":{"name":"InBanner","abstract":"\u003cp\u003eIn-Banner\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC9InArticleAEvpZ":{"name":"InArticle","abstract":"\u003cp\u003eIn-Article\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC6InFeedAEvpZ":{"name":"InFeed","abstract":"\u003cp\u003eIn-Feed\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC12InterstitialAEvpZ":{"name":"Interstitial","abstract":"\u003cp\u003eInterstitial\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC6SliderAEvpZ":{"name":"Slider","abstract":"\u003cp\u003eSlider\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC8FloatingAEvpZ":{"name":"Floating","abstract":"\u003cp\u003eFloating\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC03getD10ByRawValueyAESgSiFZ":{"name":"getPlacementByRawValue(_:)","abstract":"\u003cp\u003eHelper function\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/StartDelay.html#/s:12PrebidMobile7SignalsC10StartDelayC7PreRollAEvpZ":{"name":"PreRoll","abstract":"\u003cp\u003ePre-Roll\u003c/p\u003e","parent_name":"StartDelay"},"Classes/Signals/StartDelay.html#/s:12PrebidMobile7SignalsC10StartDelayC14GenericMidRollAEvpZ":{"name":"GenericMidRoll","abstract":"\u003cp\u003eGeneric Mid-Roll\u003c/p\u003e","parent_name":"StartDelay"},"Classes/Signals/StartDelay.html#/s:12PrebidMobile7SignalsC10StartDelayC15GenericPostRollAEvpZ":{"name":"GenericPostRoll","abstract":"\u003cp\u003eGeneric Post-Roll\u003c/p\u003e","parent_name":"StartDelay"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_1_0AEvpZ":{"name":"VAST_1_0","abstract":"\u003cp\u003eVAST 1.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_2_0AEvpZ":{"name":"VAST_2_0","abstract":"\u003cp\u003eVAST 2.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_3_0AEvpZ":{"name":"VAST_3_0","abstract":"\u003cp\u003eVAST 3.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_1_0_WrapperAEvpZ":{"name":"VAST_1_0_Wrapper","abstract":"\u003cp\u003eVAST 1.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_2_0_WrapperAEvpZ":{"name":"VAST_2_0_Wrapper","abstract":"\u003cp\u003eVAST 2.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_3_0_WrapperAEvpZ":{"name":"VAST_3_0_Wrapper","abstract":"\u003cp\u003eVAST 3.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_4_0AEvpZ":{"name":"VAST_4_0","abstract":"\u003cp\u003eVAST 4.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_4_0_WrapperAEvpZ":{"name":"VAST_4_0_Wrapper","abstract":"\u003cp\u003eVAST 4.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC9DAAST_1_0AEvpZ":{"name":"DAAST_1_0","abstract":"\u003cp\u003eDAAST 1.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC17DAAST_1_0_WRAPPERAEvpZ":{"name":"DAAST_1_0_WRAPPER","abstract":"\u003cp\u003eDAAST 1.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC15AutoPlaySoundOnAEvpZ":{"name":"AutoPlaySoundOn","abstract":"\u003cp\u003eInitiates on Page Load with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC16AutoPlaySoundOffAEvpZ":{"name":"AutoPlaySoundOff","abstract":"\u003cp\u003eInitiates on Page Load with Sound Off by Default\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC11ClickToPlayAEvpZ":{"name":"ClickToPlay","abstract":"\u003cp\u003eInitiates on Click with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC9MouseOverAEvpZ":{"name":"MouseOver","abstract":"\u003cp\u003eInitiates on Mouse-Over with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC12EnterSoundOnAEvpZ":{"name":"EnterSoundOn","abstract":"\u003cp\u003eInitiates on Entering Viewport with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC13EnterSoundOffAEvpZ":{"name":"EnterSoundOff","abstract":"\u003cp\u003eInitiates on Entering Viewport with Sound Off by Default\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7VPAID_1AEvpZ":{"name":"VPAID_1","abstract":"\u003cp\u003eVPAID 1.0\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7VPAID_2AEvpZ":{"name":"VPAID_2","abstract":"\u003cp\u003eVPAID 2.0\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7MRAID_1AEvpZ":{"name":"MRAID_1","abstract":"\u003cp\u003eMRAID-1\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC5ORMMAAEvpZ":{"name":"ORMMA","abstract":"\u003cp\u003eORMMA\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7MRAID_2AEvpZ":{"name":"MRAID_2","abstract":"\u003cp\u003eMRAID-2\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7MRAID_3AEvpZ":{"name":"MRAID_3","abstract":"\u003cp\u003eMRAID-3\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC6OMID_1AEvpZ":{"name":"OMID_1","abstract":"\u003cp\u003eOMID-1\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html":{"name":"Api","abstract":"\u003ch1 id='openrtb-api-frameworks' class='heading'\u003eOpenRTB - API Frameworks\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/PlaybackMethod.html":{"name":"PlaybackMethod","abstract":"\u003ch1 id='openrtb-playback-methods' class='heading'\u003eOpenRTB - Playback Methods\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/Protocols.html":{"name":"Protocols","abstract":"\u003ch1 id='openrtb-protocols' class='heading'\u003eOpenRTB - Protocols\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/StartDelay.html":{"name":"StartDelay","abstract":"\u003ch1 id='openrtb-start-delay' class='heading'\u003eOpenRTB - Start Delay\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/Placement.html":{"name":"Placement","abstract":"\u003ch1 id='openrtb-video-placement-types' class='heading'\u003eOpenRTB - Video Placement Types\u003c/h1\u003e","parent_name":"Signals"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)assets":{"name":"assets","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeAsset.html\"\u003eNativeAsset\u003c/a\u003e\u003c/code\u003e objects representing the assets required for the native ad request.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeEventTracker.html\"\u003eNativeEventTracker\u003c/a\u003e\u003c/code\u003e objects specifying the event tracking settings for the native ad.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)version":{"name":"version","abstract":"\u003cp\u003eThe version of the native ad specification being used. Defaults to \u0026ldquo;1.2\u0026rdquo;.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)context":{"name":"context","abstract":"\u003cp\u003eThe context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextType.html\"\u003eContextType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)contextSubType":{"name":"contextSubType","abstract":"\u003cp\u003eA more detailed context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextSubType.html\"\u003eContextSubType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)placementType":{"name":"placementType","abstract":"\u003cp\u003eThe design/format/layout of the ad unit being offered. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/PlacementType.html\"\u003ePlacementType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)placementCount":{"name":"placementCount","abstract":"\u003cp\u003eThe number of identical placements in the ad layout. Defaults to 1.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)sequence":{"name":"sequence","abstract":"\u003cp\u003eThe sequence number of the ad. Defaults to 0.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)asseturlsupport":{"name":"asseturlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning an \u003ccode\u003eassetsurl\u003c/code\u003e instead of an asset object.","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)durlsupport":{"name":"durlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning a \u003ccode\u003edco\u003c/code\u003e URL instead of an asset object.","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)privacy":{"name":"privacy","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning a \u003ccode\u003edco\u003c/code\u003e URL instead of an asset object.","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)ext":{"name":"ext","abstract":"\u003cp\u003eA placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)api":{"name":"api","abstract":"\u003cp\u003eList of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/s:12PrebidMobile16BannerParametersC24interstitialMinWidthPercSiSgvp":{"name":"interstitialMinWidthPerc","abstract":"\u003cp\u003eMin width percentage value for interstitial\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/s:12PrebidMobile16BannerParametersC25interstitialMinHeightPercSiSgvp":{"name":"interstitialMinHeightPerc","abstract":"\u003cp\u003eMin height percentage value for interstitial\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)adSizes":{"name":"adSizes","abstract":"\u003cp\u003eAd sizes of the ad\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)rawAPI":{"name":"rawAPI","abstract":"\u003cp\u003eHelper for \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)api\"\u003eapi\u003c/a\u003e\u003c/code\u003e values\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)FeedContent":{"name":"FeedContent","abstract":"\u003cp\u003ePlacement type indicating the ad appears within feed content.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)AtomicContent":{"name":"AtomicContent","abstract":"\u003cp\u003ePlacement type indicating the ad appears within atomic content.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)OutsideContent":{"name":"OutsideContent","abstract":"\u003cp\u003ePlacement type indicating the ad appears outside of content.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)RecommendationWidget":{"name":"RecommendationWidget","abstract":"\u003cp\u003ePlacement type indicating the ad appears within a recommendation widget.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003ePlacement type for custom placements not predefined in the standard.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(py)text":{"name":"text","abstract":"\u003cp\u003eThe text associated with the text element.\u003c/p\u003e","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/s:12PrebidMobile11NativeTitleC6lengthSiSgvp":{"name":"length","abstract":"\u003cp\u003eThe length of the title being provided.","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeTitle\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeTitle\u003c/code\u003e object with default values.\u003c/p\u003e","parent_name":"NativeTitle"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)version":{"name":"version","abstract":"\u003cp\u003eThe version of the native ad specification being used. Defaults to \u0026ldquo;1.2\u0026rdquo; if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)context":{"name":"context","abstract":"\u003cp\u003eThe context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextType.html\"\u003eContextType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)contextSubType":{"name":"contextSubType","abstract":"\u003cp\u003eA more detailed context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextSubType.html\"\u003eContextSubType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)placementType":{"name":"placementType","abstract":"\u003cp\u003eThe design/format/layout of the ad unit being offered. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/PlacementType.html\"\u003ePlacementType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)placementCount":{"name":"placementCount","abstract":"\u003cp\u003eThe number of identical placements in the ad layout. Defaults to 1 if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)sequence":{"name":"sequence","abstract":"\u003cp\u003eThe sequence number of the ad. Defaults to 0 if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)assets":{"name":"assets","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeAsset.html\"\u003eNativeAsset\u003c/a\u003e\u003c/code\u003e objects representing the assets required for the native ad request.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)asseturlsupport":{"name":"asseturlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning an \u003ccode\u003eassetsurl\u003c/code\u003e instead of an asset object.","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)durlsupport":{"name":"durlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning a \u003ccode\u003edco\u003c/code\u003e URL instead of an asset object.","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeEventTracker.html\"\u003eNativeEventTracker\u003c/a\u003e\u003c/code\u003e objects specifying the event tracking settings for the native ad.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)privacy":{"name":"privacy","abstract":"\u003cp\u003eIndicates whether the native ad supports a buyer-specific privacy notice. Defaults to 0 if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)ext":{"name":"ext","abstract":"\u003cp\u003eA placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)configId":{"name":"configId","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeRequest\u003c/code\u003e with a specified configuration ID.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)initWithConfigId:assets:eventTrackers:":{"name":"init(configId:assets:eventTrackers:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeRequest\u003c/code\u003e with a specified configuration ID, assets, and event trackers.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)addNativeAssets:":{"name":"addNativeAssets(_:)","abstract":"\u003cp\u003eAdds an array of native assets to the request. If assets already exist, they will be appended.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)addNativeEventTracker:":{"name":"addNativeEventTracker(_:)","abstract":"\u003cp\u003eAdds an array of native event trackers to the request. If event trackers already exist, they will be appended.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)getNativeRequestObject":{"name":"getNativeRequestObject()","abstract":"\u003cp\u003eRetrieves the native request object as a JSON dictionary.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)context":{"name":"context","abstract":"\u003cp\u003e[Recommended]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)contextsubtype":{"name":"contextsubtype","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)plcmttype":{"name":"plcmttype","abstract":"\u003cp\u003e[Recommended]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)plcmtcnt":{"name":"plcmtcnt","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)seq":{"name":"seq","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)assets":{"name":"assets","abstract":"\u003cp\u003e[Required]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)aurlsupport":{"name":"aurlsupport","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)durlsupport":{"name":"durlsupport","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eSpecifies what type of event objects tracking is supported - see Event Trackers Request Object\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)privacy":{"name":"privacy","abstract":"\u003cp\u003e[Recommended]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(im)copyWithZone:":{"name":"copy(with:)","abstract":"\u003cp\u003eCreates a copy of the current \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)jsonDictionary":{"name":"jsonDictionary","abstract":"\u003cp\u003eConverts the \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e instance to a JSON dictionary.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(im)toJsonStringWithError:":{"name":"toJsonString()","abstract":"\u003cp\u003eConverts the \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e instance to a JSON string.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)url":{"name":"url","abstract":"\u003cp\u003eLanding URL of the clickable link.\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)clicktrackers":{"name":"clicktrackers","abstract":"\u003cp\u003eList of third-party tracker URLs to be fired on click of the URL.\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)fallback":{"name":"fallback","abstract":"\u003cp\u003eFallback URL for deeplink.","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeLink\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes with default values\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeImage.html#/s:12PrebidMobile11NativeImageC4typeSiSgvp":{"name":"type","abstract":"\u003cp\u003eThe type of image element being submitted from the Image Asset Types table.","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(py)url":{"name":"url","abstract":"\u003cp\u003eURL of the image asset.\u003c/p\u003e","parent_name":"NativeImage"},"Classes/NativeImage.html#/s:12PrebidMobile11NativeImageC5widthSiSgvp":{"name":"width","abstract":"\u003cp\u003eWidth of the image in pixels.","parent_name":"NativeImage"},"Classes/NativeImage.html#/s:12PrebidMobile11NativeImageC6heightSiSgvp":{"name":"height","abstract":"\u003cp\u003eHeight of the image in pixels.","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeImage\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes with default values\u003c/p\u003e","parent_name":"NativeImage"},"Classes/NativeEventTrackerResponse.html#/s:12PrebidMobile26NativeEventTrackerResponseC5eventSiSgvp":{"name":"event","abstract":"\u003cp\u003eType of event to track.","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/s:12PrebidMobile26NativeEventTrackerResponseC6methodSiSgvp":{"name":"method","abstract":"\u003cp\u003eType of tracking requested.","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(py)url":{"name":"url","abstract":"\u003cp\u003eThe URL of the image or js.","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(py)customdata":{"name":"customdata","abstract":"\u003cp\u003eTo be agreed individually with the exchange, an array of key:value objects for custom tracking,","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeEventTrackerResponse\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes with default values\u003c/p\u003e","parent_name":"NativeEventTrackerResponse"},"Classes/EventTracking.html#/c:@M@PrebidMobile@objc(cs)EventTracking(cpy)Image":{"name":"Image","abstract":"\u003cp\u003eRepresents image-based event tracking.\u003c/p\u003e","parent_name":"EventTracking"},"Classes/EventTracking.html#/c:@M@PrebidMobile@objc(cs)EventTracking(cpy)js":{"name":"js","abstract":"\u003cp\u003eRepresents JavaScript-based event tracking.\u003c/p\u003e","parent_name":"EventTracking"},"Classes/EventTracking.html#/c:@M@PrebidMobile@objc(cs)EventTracking(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom event tracking method.\u003c/p\u003e","parent_name":"EventTracking"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)Impression":{"name":"Impression","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)ViewableImpression50":{"name":"ViewableImpression50","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)ViewableImpression100":{"name":"ViewableImpression100","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)ViewableVideoImpression50":{"name":"ViewableVideoImpression50","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/NativeEventTracker.html#/c:@M@PrebidMobile@objc(cs)NativeEventTracker(im)initWithEvent:methods:":{"name":"init(event:methods:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eNativeEventTracker\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"NativeEventTracker"},"Classes/NativeData.html#/s:12PrebidMobile10NativeDataC4typeSiSgvp":{"name":"type","abstract":"\u003cp\u003eThe type of data element being submitted from the Data Asset Types table.","parent_name":"NativeData"},"Classes/NativeData.html#/s:12PrebidMobile10NativeDataC6lengthSiSgvp":{"name":"length","abstract":"\u003cp\u003eThe length of the data element being submitted.","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(py)value":{"name":"value","abstract":"\u003cp\u003eThe formatted string of data to be displayed.","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eNativeData\u003c/code\u003e object with the provided JSON dictionary.\u003c/p\u003e","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(im)init":{"name":"init()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"NativeData"},"Classes/ImageAsset.html#/c:@M@PrebidMobile@objc(cs)ImageAsset(cpy)Icon":{"name":"Icon","abstract":"\u003cp\u003eRepresents an icon image asset.\u003c/p\u003e","parent_name":"ImageAsset"},"Classes/ImageAsset.html#/c:@M@PrebidMobile@objc(cs)ImageAsset(cpy)Main":{"name":"Main","abstract":"\u003cp\u003eRepresents the main image asset.\u003c/p\u003e","parent_name":"ImageAsset"},"Classes/ImageAsset.html#/c:@M@PrebidMobile@objc(cs)ImageAsset(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom image asset.\u003c/p\u003e","parent_name":"ImageAsset"},"Classes/NativeAssetData.html#/s:12PrebidMobile15NativeAssetDataC6lengthSiSgvp":{"name":"length","abstract":"\u003cp\u003eThe length of the data asset.\u003c/p\u003e","parent_name":"NativeAssetData"},"Classes/NativeAssetData.html#/c:@M@PrebidMobile@objc(cs)NativeAssetData(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional custom properties for the data asset.\u003c/p\u003e","parent_name":"NativeAssetData"},"Classes/NativeAssetData.html#/c:@M@PrebidMobile@objc(cs)NativeAssetData(im)initWithType:required:":{"name":"init(type:required:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetData\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetData"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(py)type":{"name":"type","abstract":"\u003cp\u003eThe type of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC5widthSiSgvp":{"name":"width","abstract":"\u003cp\u003eThe width of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC8widthMinSiSgvp":{"name":"widthMin","abstract":"\u003cp\u003eThe minimum width of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC6heightSiSgvp":{"name":"height","abstract":"\u003cp\u003eThe height of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC9heightMinSiSgvp":{"name":"heightMin","abstract":"\u003cp\u003eThe minimum height of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(py)mimes":{"name":"mimes","abstract":"\u003cp\u003eThe MIME types supported for the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional custom properties for the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(im)initWithMinimumWidth:minimumHeight:required:":{"name":"init(minimumWidth:minimumHeight:required:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetImage\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(im)initWithIsRequired:":{"name":"init(isRequired:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetImage\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetTitle.html#/c:@M@PrebidMobile@objc(cs)NativeAssetTitle(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional custom properties for the title asset.\u003c/p\u003e","parent_name":"NativeAssetTitle"},"Classes/NativeAssetTitle.html#/c:@M@PrebidMobile@objc(cs)NativeAssetTitle(im)initWithLength:required:":{"name":"init(length:required:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetTitle\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetTitle"},"Classes/NativeAsset.html#/s:12PrebidMobile11NativeAssetC8requiredSbvp":{"name":"required","abstract":"\u003cp\u003eIndicates whether the asset is required for the ad to be considered valid.\u003c/p\u003e","parent_name":"NativeAsset"},"Classes/NativeAsset.html#/s:12PrebidMobile11NativeAssetC10isRequiredACSb_tcfc":{"name":"init(isRequired:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAsset\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAsset"},"Classes/NativeAdMarkupAsset.html#/s:12PrebidMobile19NativeAdMarkupAssetC2idSiSgvp":{"name":"id","abstract":"\u003cp\u003eOptional if asseturl/dcourl is being used; required if embeded asset is being used\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/s:12PrebidMobile19NativeAdMarkupAssetC8requiredSiSgvp":{"name":"required","abstract":"\u003cp\u003eSet to 1 if asset is required. (bidder requires it to be displayed).\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)title":{"name":"title","abstract":"\u003cp\u003eTitle object for title assets.","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)img":{"name":"img","abstract":"\u003cp\u003eImage object for image assets.","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)data":{"name":"data","abstract":"\u003cp\u003eData object for ratings, prices etc.\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)link":{"name":"link","abstract":"\u003cp\u003eLink object for call to actions.","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkupAsset\u003c/code\u003e from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkupAsset\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)version":{"name":"version","abstract":"\u003cp\u003eVersion of the Native Markup version in use.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)assets":{"name":"assets","abstract":"\u003cp\u003eList of native ad’s assets.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)assetsurl":{"name":"assetsurl","abstract":"\u003cp\u003eURL of an alternate source for the assets object.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)dcourl":{"name":"dcourl","abstract":"\u003cp\u003eURL where a dynamic creative specification may be found for populating this ad, per the Dynamic Content Ads Specification.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)link":{"name":"link","abstract":"\u003cp\u003eDestination Link.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)imptrackers":{"name":"imptrackers","abstract":"\u003cp\u003eArray of impression tracking URLs, expected to return a 1x1 image or 204 response - typically only passed when using 3rd party trackers.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)jstracker":{"name":"jstracker","abstract":"\u003cp\u003eOptional JavaScript impression tracker.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eArray of tracking objects to run with the ad, in response to the declared supported methods in the request.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)privacy":{"name":"privacy","abstract":"\u003cp\u003eIf support was indicated in the request, URL of a page informing the user about the buyer’s targeting activity.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(im)initWithJsonString:":{"name":"init(jsonString:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkup\u003c/code\u003e from a JSON string.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkup\u003c/code\u003e from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkup\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMNativeAdConfiguration(py)version":{"name":"version","abstract":"\u003cp\u003eVersion of the Native Markup version in use.\u003c/p\u003e","parent_name":"NativeAdConfiguration"},"Classes/NativeAdConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMNativeAdConfiguration(py)markupRequestObject":{"name":"markupRequestObject","abstract":"\u003cp\u003eThe object containing the request details for the native markup.\u003c/p\u003e","parent_name":"NativeAdConfiguration"},"Classes/NativeAdConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMNativeAdConfiguration(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeAdMarkup.html\"\u003eNativeAdMarkup\u003c/a\u003e\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeAdConfiguration"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)nativeAdMarkup":{"name":"nativeAdMarkup","abstract":"\u003cp\u003eThe native ad markup containing the ad assets.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eThe delegate to receive native ad events.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)titles":{"name":"titles","abstract":"\u003cp\u003eReturns an array of titles from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)dataObjects":{"name":"dataObjects","abstract":"\u003cp\u003eReturns an array of data objects from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)images":{"name":"images","abstract":"\u003cp\u003eReturns an array of images from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)eventTrackers":{"name":"eventTrackers","abstract":"\u003cp\u003eReturns an array of event trackers from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(im)dataObjectsOf:":{"name":"dataObjects(of:)","abstract":"\u003cp\u003eReturns an array of data objects filtered by the specified data type.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(im)imagesOf:":{"name":"images(of:)","abstract":"\u003cp\u003eReturns an array of images filtered by the specified image type.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)title":{"name":"title","abstract":"\u003cp\u003eReturns the first title text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)imageUrl":{"name":"imageUrl","abstract":"\u003cp\u003eReturns the URL of the main image from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)iconUrl":{"name":"iconUrl","abstract":"\u003cp\u003eReturns the URL of the icon image from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)sponsoredBy":{"name":"sponsoredBy","abstract":"\u003cp\u003eReturns the sponsored by text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)text":{"name":"text","abstract":"\u003cp\u003eReturns the description text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)callToAction":{"name":"callToAction","abstract":"\u003cp\u003eReturns the call-to-action text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(cm)createWithCacheId:":{"name":"create(cacheId:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003eNativeAd\u003c/code\u003e instance from the given cache ID.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(im)registerViewWithView:clickableViews:":{"name":"registerView(view:clickableViews:)","abstract":"\u003cp\u003eRegisters a view for tracking viewability and click events.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Content":{"name":"Content","abstract":"\u003cp\u003eRepresents a content context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Social":{"name":"Social","abstract":"\u003cp\u003eRepresents a social media context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Product":{"name":"Product","abstract":"\u003cp\u003eRepresents a product context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)General":{"name":"General","abstract":"\u003cp\u003eRepresents a general context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Article":{"name":"Article","abstract":"\u003cp\u003eRepresents an article context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Video":{"name":"Video","abstract":"\u003cp\u003eRepresents a video context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Audio":{"name":"Audio","abstract":"\u003cp\u003eRepresents an audio context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Image":{"name":"Image","abstract":"\u003cp\u003eRepresents an image context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)UserGenerated":{"name":"UserGenerated","abstract":"\u003cp\u003eRepresents a user-generated content context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Social":{"name":"Social","abstract":"\u003cp\u003eRepresents a social media context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)email":{"name":"email","abstract":"\u003cp\u003eRepresents an email context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)chatIM":{"name":"chatIM","abstract":"\u003cp\u003eRepresents a chat or instant messaging context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)SellingProduct":{"name":"SellingProduct","abstract":"\u003cp\u003eRepresents a product selling context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)AppStore":{"name":"AppStore","abstract":"\u003cp\u003eRepresents an App Store context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)ReviewSite":{"name":"ReviewSite","abstract":"\u003cp\u003eRepresents a review site context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)initWithBannerParameters:videoParameters:nativeParameters:isInterstitial:isRewarded:":{"name":"init(bannerParameters:videoParameters:nativeParameters:isInterstitial:isRewarded:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003ePrebidRequest\u003c/code\u003e with the given parameters.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)setGPID:":{"name":"setGPID(_:)","abstract":"\u003cp\u003eSets the GPID for the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content for the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the app content for the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds data to the app content.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves specific data from the app content.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all data from the app content.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds user data to the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves specific user data from the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data from the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(py)pbAdSlot":{"name":"pbAdSlot","abstract":"\u003cp\u003eThe ad slot identifier for the Prebid ad unit.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003ePrebidAdUnit\u003c/code\u003e with the given configuration ID.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)fetchDemandWithAdObject:request:completion:":{"name":"fetchDemand(adObject:request:completion:)","abstract":"\u003cp\u003eMakes bid request for the specified ad object and request config. Setups targeting keywords into the adObject.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)fetchDemandWithRequest:completion:":{"name":"fetchDemand(request:completion:)","abstract":"\u003cp\u003eMakes bid request for the specified request config.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)setAutoRefreshMillisWithTime:":{"name":"setAutoRefreshMillis(time:)","abstract":"\u003cp\u003eThis method allows to set the auto refresh period for the demand\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)stopAutoRefresh":{"name":"stopAutoRefresh()","abstract":"\u003cp\u003eThis method stops the auto refresh of demand\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)resumeAutoRefresh":{"name":"resumeAutoRefresh()","abstract":"\u003cp\u003eThis method resumes the auto refresh of demand\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(cpy)EVENT_WIN":{"name":"EVENT_WIN","abstract":"\u003cp\u003eKey to get Prebid win event from \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)events\"\u003eevents\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(cpy)EVENT_IMP":{"name":"EVENT_IMP","abstract":"\u003cp\u003eKey to get Prebid imp event from \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)events\"\u003eevents\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)resultCode":{"name":"resultCode","abstract":"\u003cp\u003eThe result code of the bid request\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)targetingKeywords":{"name":"targetingKeywords","abstract":"\u003cp\u003eTargeting keywords associated with the bid\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/s:12PrebidMobile7BidInfoC3expSdSgvp":{"name":"exp","abstract":"\u003cp\u003eThe expiration time of the bid\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)nativeAdCacheId":{"name":"nativeAdCacheId","abstract":"\u003cp\u003eThe cache ID for native ads\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)events":{"name":"events","abstract":"\u003cp\u003eEvents related to the bid\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/s:12PrebidMobile7BidInfoC10resultCode17targetingKeywords3exp15nativeAdCacheId6eventsAcA06ResultF0O_SDyS2SGSgSdSgSSSgAKtcfc":{"name":"init(resultCode:targetingKeywords:exp:nativeAdCacheId:events:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBidInfo\u003c/code\u003e instance with the specified parameters.\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(im)getExp":{"name":"getExp()","abstract":"\u003cp\u003eRetrieves the expiration time of the bid as an \u003ccode\u003eNSNumber\u003c/code\u003e.\u003c/p\u003e","parent_name":"BidInfo"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eThe deprecated banner parameters for this ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eThe banner parameters for this ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video parameters for this ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe ad formats for the ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a new interstitial ad unit with a unique configuration identifier.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(im)initWithConfigId:minWidthPerc:minHeightPerc:":{"name":"init(configId:minWidthPerc:minHeightPerc:)","abstract":"\u003cp\u003eInitializes a new interstitial ad unit with a minimum width and height percentage.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InstreamVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)InstreamVideoAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video parameters for this ad unit.\u003c/p\u003e","parent_name":"InstreamVideoAdUnit"},"Classes/InstreamVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)InstreamVideoAdUnit(im)initWithConfigId:size:":{"name":"init(configId:size:)","abstract":"\u003cp\u003eInitializes a new instream video ad unit.\u003c/p\u003e","parent_name":"InstreamVideoAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eA deprecated property for banner ad parameters.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eThe banner ad parameters used to configure the ad unit.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video ad parameters used to configure the ad unit.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe set of ad formats for the ad unit.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(im)initWithConfigId:size:":{"name":"init(configId:size:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBannerAdUnit\u003c/code\u003e with the specified configuration ID and size.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(im)addAdditionalSizeWithSizes:":{"name":"addAdditionalSize(sizes:)","abstract":"\u003cp\u003eAdds additional sizes to the banner ad unit\u0026rsquo;s configuration.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(py)pbAdSlot":{"name":"pbAdSlot","abstract":"\u003cp\u003eORTB: imp[].ext.data.adslot\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/s:12PrebidMobile6AdUnitC8configId4size9adFormatsACSS_So6CGSizeVSgShyAA0C6FormatCGtcfc":{"name":"init(configId:size:adFormats:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eAdUnit\u003c/code\u003e instance with the specified configuration ID, size, and ad formats.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request and provides the result as a dictionary of key-value pairs.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)fetchDemandWithCompletionBidInfo:":{"name":"fetchDemand(completionBidInfo:)","abstract":"\u003cp\u003eMakes bid request and provides the result as a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BidInfo.html\"\u003eBidInfo\u003c/a\u003e\u003c/code\u003e object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)fetchDemandWithAdObject:completion:":{"name":"fetchDemand(adObject:completion:)","abstract":"\u003cp\u003eMakes bid request for a specific ad object and provides the result code. Setups targeting keywords into the adObject.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getAppContent":{"name":"getAppContent()","abstract":"\u003cp\u003eRetrieves the current app content object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all content data objects from the app content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getUserData":{"name":"getUserData()","abstract":"\u003cp\u003eRetrieves the current user data.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setGPID:":{"name":"setGPID(_:)","abstract":"\u003cp\u003eSets the GPID for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getGPID":{"name":"getGPID()","abstract":"\u003cp\u003eRetrieves the current GPID for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setOrtbConfig:":{"name":"setOrtbConfig(_:)","abstract":"\u003cp\u003eSets the OpenRTB configuration string for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getOrtbConfig":{"name":"getOrtbConfig()","abstract":"\u003cp\u003eRetrieves the current OpenRTB configuration string for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setAutoRefreshMillisWithTime:":{"name":"setAutoRefreshMillis(time:)","abstract":"\u003cp\u003eThis method allows to set the auto refresh period for the demand\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)stopAutoRefresh":{"name":"stopAutoRefresh()","abstract":"\u003cp\u003eThis method stops the auto refresh of demand\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)resumeAutoRefresh":{"name":"resumeAutoRefresh()","abstract":"\u003cp\u003eThis method resumes the auto refresh of demand\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html":{"name":"AdUnit","abstract":"\u003cp\u003eBase class for ad units built for original type of integration.\u003c/p\u003e"},"Classes/BannerAdUnit.html":{"name":"BannerAdUnit","abstract":"\u003cp\u003eA class representing a banner ad unit for original type of integration.\u003c/p\u003e"},"Classes/InstreamVideoAdUnit.html":{"name":"InstreamVideoAdUnit","abstract":"\u003cp\u003eRepresents an instream video ad unit for original type of integration.\u003c/p\u003e"},"Classes/InterstitialAdUnit.html":{"name":"InterstitialAdUnit","abstract":"\u003cp\u003eRepresents an interstitial ad unit built for original type of integration.\u003c/p\u003e"},"Classes/BidInfo.html":{"name":"BidInfo","abstract":"\u003cp\u003eContains information about bid.\u003c/p\u003e"},"Classes/PrebidAdUnit.html":{"name":"PrebidAdUnit","abstract":"\u003cp\u003eMultiformat ad unit. Built for original API.\u003c/p\u003e"},"Classes/PrebidRequest.html":{"name":"PrebidRequest","abstract":"\u003cp\u003eClass that contains properties and methods to configure Prebid request.\u003c/p\u003e"},"Classes/ContextSubType.html":{"name":"ContextSubType","abstract":"\u003cp\u003eNative context subtype asset.\u003c/p\u003e"},"Classes/ContextType.html":{"name":"ContextType","abstract":"\u003cp\u003eNative context type asset.\u003c/p\u003e"},"Classes/NativeAd.html":{"name":"NativeAd","abstract":"\u003cp\u003eRepresents a native ad and handles its various properties and functionalities.\u003c/p\u003e"},"Classes/NativeAdConfiguration.html":{"name":"NativeAdConfiguration","abstract":"\u003cp\u003eRepresents the configuration for a native ad, including markup and version information.\u003c/p\u003e"},"Classes/NativeAdMarkup.html":{"name":"NativeAdMarkup","abstract":"\u003cp\u003eRepresents the markup for a native ad, including assets, tracking URLs, and other metadata.\u003c/p\u003e"},"Classes/NativeAdMarkupAsset.html":{"name":"NativeAdMarkupAsset","abstract":"\u003cp\u003eRepresents an asset in the native ad markup, which can be a title, image, data, or link.\u003c/p\u003e"},"Classes/NativeAsset.html":{"name":"NativeAsset","abstract":"\u003cp\u003eRepresents a generic native ad asset which could be a title, image, or data.\u003c/p\u003e"},"Classes/NativeAssetTitle.html":{"name":"NativeAssetTitle","abstract":"\u003cp\u003eRepresents a title asset in a native ad.\u003c/p\u003e"},"Classes/NativeAssetImage.html":{"name":"NativeAssetImage","abstract":"\u003cp\u003eRepresents an image asset in a native ad.\u003c/p\u003e"},"Classes/NativeAssetData.html":{"name":"NativeAssetData","abstract":"\u003cp\u003eRepresents a data asset in a native ad.\u003c/p\u003e"},"Classes/ImageAsset.html":{"name":"ImageAsset","abstract":"\u003cp\u003eNative image asset type.\u003c/p\u003e"},"Classes/NativeData.html":{"name":"NativeData","abstract":"\u003cp\u003eClass representing native data elements in the ad markup.\u003c/p\u003e"},"Classes/NativeEventTracker.html":{"name":"NativeEventTracker","abstract":"\u003cp\u003eClass representing an event tracker for native ads.\u003c/p\u003e"},"Classes/EventType.html":{"name":"EventType","abstract":"\u003cp\u003eClass representing different event types.\u003c/p\u003e"},"Classes/EventTracking.html":{"name":"EventTracking","abstract":"\u003cp\u003eNative event tracking type.\u003c/p\u003e"},"Classes/NativeEventTrackerResponse.html":{"name":"NativeEventTrackerResponse","abstract":"\u003cp\u003eClass representing a response for a native event tracker.\u003c/p\u003e"},"Classes/NativeImage.html":{"name":"NativeImage","abstract":"\u003cp\u003eClass representing an image asset in a native ad.\u003c/p\u003e"},"Classes/NativeLink.html":{"name":"NativeLink","abstract":"\u003cp\u003eClass representing a link in a native ad.\u003c/p\u003e"},"Classes/NativeMarkupRequestObject.html":{"name":"NativeMarkupRequestObject","abstract":"\u003cp\u003eRepresents a request object for native markup, including details about the ad\u0026rsquo;s context, placement, and supported features.\u003c/p\u003e"},"Classes/NativeRequest.html":{"name":"NativeRequest","abstract":"\u003cp\u003eA class representing a native request for original type of integration.\u003c/p\u003e"},"Classes/NativeTitle.html":{"name":"NativeTitle","abstract":"\u003cp\u003eRepresents the title element in a native ad, including optional text and length.\u003c/p\u003e"},"Classes/PlacementType.html":{"name":"PlacementType","abstract":"\u003cp\u003eRepresents different types of placements for native ads.\u003c/p\u003e"},"Classes/BannerParameters.html":{"name":"BannerParameters","abstract":"\u003cp\u003eDescribes an \u003ca href=\"https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf\"\u003eOpenRTB\u003c/a\u003e banner object\u003c/p\u003e"},"Classes/NativeParameters.html":{"name":"NativeParameters","abstract":"\u003cp\u003eRepresents parameters for a native ad request, including assets, event trackers, and configuration settings.\u003c/p\u003e"},"Classes/Signals.html":{"name":"Signals","abstract":"\u003cp\u003eA class containing constants related to OpenRTB signals.\u003c/p\u003e"},"Classes/SingleContainerInt.html":{"name":"SingleContainerInt","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e"},"Classes/VideoParameters.html":{"name":"VideoParameters","abstract":"\u003cp\u003eDescribes an \u003ca href=\"https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf\"\u003eOpenRTB\u003c/a\u003e video object\u003c/p\u003e"},"Classes/RewardedVideoAdUnit.html":{"name":"RewardedVideoAdUnit","abstract":"\u003cp\u003eRepresents an rewarded ad unit for original type of integration.\u003c/p\u003e"},"Classes/Utils.html":{"name":"Utils","abstract":"\u003cp\u003eA utility class for handling various ad-related operations and conversions.\u003c/p\u003e"},"Classes/VideoAdUnit.html":{"name":"VideoAdUnit","abstract":"\u003cp\u003eA deprecated class for handling video ad units.\u003c/p\u003e"},"Classes/VideoInterstitialAdUnit.html":{"name":"VideoInterstitialAdUnit","abstract":"\u003cp\u003eA deprecated class representing a video interstitial ad unit."},"Classes/Prebid.html":{"name":"Prebid","abstract":"\u003cp\u003eThe \u003ccode\u003ePrebid\u003c/code\u003e class manages the configuration and initialization of the PrebidMobile SDK.\u003c/p\u003e"},"Classes/Targeting.html":{"name":"Targeting","abstract":"\u003cp\u003eA class that manages targeting information for ads.\u003c/p\u003e"},"Classes/ExternalUserId.html":{"name":"ExternalUserId","abstract":"\u003cp\u003eDefines the User Id Object from an External Thrid Party Source\u003c/p\u003e"},"Classes/Host.html":{"name":"Host","abstract":"\u003cp\u003eA singleton class that manages the Prebid server URL, including a custom URL.\u003c/p\u003e"},"Classes/AdFormat.html":{"name":"AdFormat","abstract":"\u003cp\u003e\u003ccode\u003eAdFormat\u003c/code\u003e is a class that represents different types of ad formats using an OptionSet."},"Classes/VideoControlsConfiguration.html":{"name":"VideoControlsConfiguration","abstract":"\u003cp\u003eA class representing the configuration for video controls in an ad."},"Classes/BannerView.html":{"name":"BannerView","abstract":"\u003cp\u003eThe view that will display the particular banner ad. Built for rendering type of integration.\u003c/p\u003e"},"Classes/BaseInterstitialAdUnit.html":{"name":"BaseInterstitialAdUnit","abstract":"\u003cp\u003eA base class for interstitial ad units.\u003c/p\u003e"},"Classes/InterstitialRenderingAdUnit.html":{"name":"InterstitialRenderingAdUnit","abstract":"\u003cp\u003eRepresents an interstitial ad unit. Built for rendering type of integration.\u003c/p\u003e"},"Classes/RewardedAdUnit.html":{"name":"RewardedAdUnit","abstract":"\u003cp\u003eRepresents an rewarded ad unit. Built for rendering type of integration.\u003c/p\u003e"},"Classes/MediationBannerAdUnit.html":{"name":"MediationBannerAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes/MediationBaseInterstitialAdUnit.html":{"name":"MediationBaseInterstitialAdUnit","abstract":"\u003cp\u003eBase class for interstitial ads in Mediation API.\u003c/p\u003e"},"Classes/MediationInterstitialAdUnit.html":{"name":"MediationInterstitialAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes/MediationNativeAdUnit.html":{"name":"MediationNativeAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes/MediationRewardedAdUnit.html":{"name":"MediationRewardedAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes.html":{"name":"Classes","abstract":"\u003cp\u003eThe following classes are available globally.\u003c/p\u003e"},"Enums.html":{"name":"Enumerations","abstract":"\u003cp\u003eThe following enumerations are available globally.\u003c/p\u003e"},"Protocols.html":{"name":"Protocols","abstract":"\u003cp\u003eThe following protocols are available globally.\u003c/p\u003e"},"Typealiases.html":{"name":"Type Aliases","abstract":"\u003cp\u003eThe following type aliases are available globally.\u003c/p\u003e"}} \ No newline at end of file diff --git a/docs/docsets/PrebidMobile.docset/Contents/Resources/docSet.dsidx b/docs/docsets/PrebidMobile.docset/Contents/Resources/docSet.dsidx new file mode 100644 index 000000000..3b6ad97c4 Binary files /dev/null and b/docs/docsets/PrebidMobile.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docsets/PrebidMobile.tgz b/docs/docsets/PrebidMobile.tgz new file mode 100644 index 000000000..f8a81625a Binary files /dev/null and b/docs/docsets/PrebidMobile.tgz differ diff --git a/docs/img/carat.png b/docs/img/carat.png new file mode 100755 index 000000000..29d2f7fd4 Binary files /dev/null and b/docs/img/carat.png differ diff --git a/docs/img/dash.png b/docs/img/dash.png new file mode 100755 index 000000000..6f694c7a0 Binary files /dev/null and b/docs/img/dash.png differ diff --git a/docs/img/spinner.gif b/docs/img/spinner.gif new file mode 100644 index 000000000..e3038d0a4 Binary files /dev/null and b/docs/img/spinner.gif differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..9fdcc66c5 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,334 @@ + + + + PrebidMobile Reference + + + + + + + + + + + + +
      +
      +

      PrebidMobile 2.2.3 Docs (94% documented)

      +
      +
      + +
      +
      +
      +
      +
      + +
      +
      + +
      +
      +
      + +

      Prebid Mobile iOS SDK

      + +

      To work with Prebid Mobile, you will need accesss to a Prebid Server. See this page for options.

      +

      Use Cocoapods?

      + +

      Easily include the Prebid Mobile SDK for your primary ad server in your Podfile/

      +
      platform :ios, '11.0'
+
+target 'MyAmazingApp' do 
+    pod 'PrebidMobile'
+end
+
      +

      Build framework from source

      + +

      Build Prebid Mobile from source code. After cloning the repo, from the root directory run

      +
      ./scripts/buildPrebidMobile.sh
+
      + +

      to output the Prebid Mobile framework.

      +

      Test Prebid Mobile

      + +

      Run the test script to run unit tests and integration tests.

      +
      ./scripts/testPrebidMobile.sh
+
      +

      Carthage

      + +

      2.2.3 version is available to build PrebidMobile with Carthage. For that, please, put the following content to your Cartfile:

      +
      github "prebid/prebid-mobile-ios" == 2.2.3-carthage
+
      + +

      Run this command in order to build PrebidMobile with Carthage:

      +
      carthage update --use-xcframeworks --platform ios
+
      + +

      Note that PrebidMobileGAMEventHandlers, PrebidMobileAdMobAdapters, PrebidMobileMAXAdapters are not available to build with Carthage.

      + +
      +
      + +
      +
      + + diff --git a/docs/js/jazzy.js b/docs/js/jazzy.js new file mode 100755 index 000000000..198441660 --- /dev/null +++ b/docs/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/docs/js/jazzy.search.js b/docs/js/jazzy.search.js new file mode 100644 index 000000000..359cdbb8b --- /dev/null +++ b/docs/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
      '; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
      '; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/docs/js/jquery.min.js b/docs/js/jquery.min.js new file mode 100644 index 000000000..7f37b5d99 --- /dev/null +++ b/docs/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
      "],col:[2,"","
      "],tr:[2,"","
      "],td:[3,"","
      "],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
      ",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/js/typeahead.jquery.js b/docs/js/typeahead.jquery.js new file mode 100644 index 000000000..bcb734bef --- /dev/null +++ b/docs/js/typeahead.jquery.js @@ -0,0 +1,1695 @@ +/*! + * typeahead.js 1.3.3 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2024 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
      ' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + "aria-controls": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
      "); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
      "); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
      ').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
      ").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
      "); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
      "); + $menu = this.menu.$node || $("
      "); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/docs/search.json b/docs/search.json new file mode 100644 index 000000000..de2d0dd8d --- /dev/null +++ b/docs/search.json @@ -0,0 +1 @@ +{"Typealiases.html#/s:12PrebidMobile0A22InitializationCallbacka":{"name":"PrebidInitializationCallback","abstract":"\u003cp\u003eA callback used for Prebid initialization status.\u003c/p\u003e"},"Protocols/PrebidMediationDelegate.html#/c:@M@PrebidMobile@objc(pl)PrebidMediationDelegate(im)setUpAdObjectWith:":{"name":"setUpAdObject(with:)","abstract":"\u003cp\u003ePuts to ad object\u0026rsquo;s localExtra the ad object (winning bid or native ad) and configId","parent_name":"PrebidMediationDelegate"},"Protocols/PrebidMediationDelegate.html#/c:@M@PrebidMobile@objc(pl)PrebidMediationDelegate(im)cleanUpAdObject":{"name":"cleanUpAdObject()","abstract":"\u003cp\u003eRemoves an bid info from ad object\u0026rsquo;s localExtra","parent_name":"PrebidMediationDelegate"},"Protocols/PrebidMediationDelegate.html#/c:@M@PrebidMobile@objc(pl)PrebidMediationDelegate(im)getAdView":{"name":"getAdView()","abstract":"\u003cp\u003eReturns ad view that was passed into PrebidMediationDelegate earlier.","parent_name":"PrebidMediationDelegate"},"Protocols/RewardedEventHandlerProtocol.html#/c:@M@PrebidMobile@objc(pl)RewardedEventHandlerProtocol(py)loadingDelegate":{"name":"loadingDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.\u003c/p\u003e","parent_name":"RewardedEventHandlerProtocol"},"Protocols/RewardedEventHandlerProtocol.html#/c:@M@PrebidMobile@objc(pl)RewardedEventHandlerProtocol(py)interactionDelegate":{"name":"interactionDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the user\u0026rsquo;s interaction with the ad.\u003c/p\u003e","parent_name":"RewardedEventHandlerProtocol"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdDidReceiveAd:":{"name":"rewardedAdDidReceiveAd(_:)","abstract":"\u003cp\u003eCalled when an ad is loaded and ready for display\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdUserDidEarnReward:":{"name":"rewardedAdUserDidEarnReward(_:)","abstract":"\u003cp\u003eCalled when user is able to receive a reward from the app\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAd:didFailToReceiveAdWithError:":{"name":"rewardedAd(_:didFailToReceiveAdWithError:)","abstract":"\u003cp\u003eCalled when the load process fails to produce a viable ad\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdWillPresentAd:":{"name":"rewardedAdWillPresentAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial view will be launched, as a result of show() method.\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdDidDismissAd:":{"name":"rewardedAdDidDismissAd(_:)","abstract":"\u003cp\u003eCalled when the interstial is dismissed by the user\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdWillLeaveApplication:":{"name":"rewardedAdWillLeaveApplication(_:)","abstract":"\u003cp\u003eCalled when an ad causes the sdk to leave the app\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/RewardedAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)RewardedAdUnitDelegate(im)rewardedAdDidClickAd:":{"name":"rewardedAdDidClickAd(_:)","abstract":"\u003cp\u003eCalled when user clicked the ad\u003c/p\u003e","parent_name":"RewardedAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialDidReceiveAd:":{"name":"interstitialDidReceiveAd(_:)","abstract":"\u003cp\u003eCalled when an ad is loaded and ready for display\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitial:didFailToReceiveAdWithError:":{"name":"interstitial(_:didFailToReceiveAdWithError:)","abstract":"\u003cp\u003eCalled when the load process fails to produce a viable ad\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialWillPresentAd:":{"name":"interstitialWillPresentAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial view will be launched, as a result of show() method.\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialDidDismissAd:":{"name":"interstitialDidDismissAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial is dismissed by the user\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialWillLeaveApplication:":{"name":"interstitialWillLeaveApplication(_:)","abstract":"\u003cp\u003eCalled when an ad causes the sdk to leave the app\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/InterstitialAdUnitDelegate.html#/c:@M@PrebidMobile@objc(pl)InterstitialAdUnitDelegate(im)interstitialDidClickAd:":{"name":"interstitialDidClickAd(_:)","abstract":"\u003cp\u003eCalled when user clicked the ad\u003c/p\u003e","parent_name":"InterstitialAdUnitDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewPresentationController":{"name":"bannerViewPresentationController()","abstract":"\u003cp\u003eAsks the delegate for a view controller instance to use for presenting modal views","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerView:didReceiveAdWithAdSize:":{"name":"bannerView(_:didReceiveAdWithAdSize:)","abstract":"\u003cp\u003eNotifies the delegate that an ad has been successfully loaded and rendered.\u003c/p\u003e","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerView:didFailToReceiveAdWith:":{"name":"bannerView(_:didFailToReceiveAdWith:)","abstract":"\u003cp\u003eNotifies the delegate of an error encountered while loading or rendering an ad.\u003c/p\u003e","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewWillLeaveApplication:":{"name":"bannerViewWillLeaveApplication(_:)","abstract":"\u003cp\u003eNotifies the delegate whenever current app goes in the background due to user click.\u003c/p\u003e","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewWillPresentModal:":{"name":"bannerViewWillPresentModal(_:)","abstract":"\u003cp\u003eNotifies delegate that the banner view will launch a modal","parent_name":"BannerViewDelegate"},"Protocols/BannerViewDelegate.html#/c:@M@PrebidMobile@objc(pl)BannerViewDelegate(im)bannerViewDidDismissModal:":{"name":"bannerViewDidDismissModal(_:)","abstract":"\u003cp\u003eNotifies delegate that the banner view has dismissed the modal on top of","parent_name":"BannerViewDelegate"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(py)loadingDelegate":{"name":"loadingDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the ad server communication.\u003c/p\u003e","parent_name":"BannerEventHandler"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(py)interactionDelegate":{"name":"interactionDelegate","abstract":"\u003cp\u003eDelegate for custom event handler to inform the PBM SDK about the events related to the user\u0026rsquo;s interaction with the ad.\u003c/p\u003e","parent_name":"BannerEventHandler"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(py)adSizes":{"name":"adSizes","abstract":"\u003cp\u003eThe array of the CGRect entries for each valid ad sizes.","parent_name":"BannerEventHandler"},"Protocols/BannerEventHandler.html#/c:@M@PrebidMobile@objc(pl)BannerEventHandler(im)trackImpression":{"name":"trackImpression()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerEventHandler"},"Protocols/NativeAdEventDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdEventDelegate(im)adDidExpireWithAd:":{"name":"adDidExpire(ad:)","abstract":"\u003cp\u003eSent when the native ad is expired.\u003c/p\u003e","parent_name":"NativeAdEventDelegate"},"Protocols/NativeAdEventDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdEventDelegate(im)adWasClickedWithAd:":{"name":"adWasClicked(ad:)","abstract":"\u003cp\u003eSent when the native view is clicked by the user.\u003c/p\u003e","parent_name":"NativeAdEventDelegate"},"Protocols/NativeAdEventDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdEventDelegate(im)adDidLogImpressionWithAd:":{"name":"adDidLogImpression(ad:)","abstract":"\u003cp\u003eSent when an impression is recorded for an native ad\u003c/p\u003e","parent_name":"NativeAdEventDelegate"},"Protocols/NativeAdDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdDelegate(im)nativeAdLoadedWithAd:":{"name":"nativeAdLoaded(ad:)","abstract":"\u003cp\u003eA successful Prebid Native ad is returned\u003c/p\u003e","parent_name":"NativeAdDelegate"},"Protocols/NativeAdDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdDelegate(im)nativeAdNotFound":{"name":"nativeAdNotFound()","abstract":"\u003cp\u003ePrebid Native was not found in the server returned response,","parent_name":"NativeAdDelegate"},"Protocols/NativeAdDelegate.html#/c:@M@PrebidMobile@objc(pl)NativeAdDelegate(im)nativeAdNotValid":{"name":"nativeAdNotValid()","abstract":"\u003cp\u003ePrebid Native ad was returned, however, the bid is not valid for displaying","parent_name":"NativeAdDelegate"},"Protocols/NativeAdDelegate.html":{"name":"NativeAdDelegate","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e"},"Protocols/NativeAdEventDelegate.html":{"name":"NativeAdEventDelegate","abstract":"\u003cp\u003eA protocol for handling events related to native ads.\u003c/p\u003e"},"Protocols/BannerEventHandler.html":{"name":"BannerEventHandler","abstract":"\u003cp\u003eA protocol for handling events related to banner ads in the PBM SDK.\u003c/p\u003e"},"Protocols/BannerViewDelegate.html":{"name":"BannerViewDelegate","abstract":"\u003cp\u003eA protocol for handling events related to banner ads in the PBM SDK.\u003c/p\u003e"},"Protocols/InterstitialAdUnitDelegate.html":{"name":"InterstitialAdUnitDelegate","abstract":"\u003cp\u003eProtocol for interaction with the InterstitialAdUnit .\u003c/p\u003e"},"Protocols/RewardedAdUnitDelegate.html":{"name":"RewardedAdUnitDelegate","abstract":"\u003cp\u003eProtocol for interaction with the RewardedAdUnit"},"Protocols/RewardedEventHandlerProtocol.html":{"name":"RewardedEventHandlerProtocol","abstract":"\u003cp\u003eA protocol for handling events related to rewarded ads.\u003c/p\u003e"},"Protocols/PrebidMediationDelegate.html":{"name":"PrebidMediationDelegate","abstract":"\u003cp\u003eThis protocol is dedicated to manage the work with Mediation SDKs.\u003c/p\u003e"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidDemandFetchSuccess":{"name":"prebidDemandFetchSuccess","abstract":"\u003cp\u003eThe demand fetch request was successful.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidServerNotSpecified":{"name":"prebidServerNotSpecified","abstract":"\u003cp\u003eThe Prebid server was not specified in the request.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidAccountId":{"name":"prebidInvalidAccountId","abstract":"\u003cp\u003eThe account ID provided is not recognized by the Prebid server.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidConfigId":{"name":"prebidInvalidConfigId","abstract":"\u003cp\u003eThe config ID provided is not recognized by the Prebid server.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidSize":{"name":"prebidInvalidSize","abstract":"\u003cp\u003eThe size requested is not recognized by the Prebid server.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidNetworkError":{"name":"prebidNetworkError","abstract":"\u003cp\u003eThere was a network error during the operation.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidServerError":{"name":"prebidServerError","abstract":"\u003cp\u003eThe Prebid server encountered an error while processing the request.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidDemandNoBids":{"name":"prebidDemandNoBids","abstract":"\u003cp\u003eThe Prebid server did not return any bids.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidDemandTimedOut":{"name":"prebidDemandTimedOut","abstract":"\u003cp\u003eThe demand request timed out.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidServerURLInvalid":{"name":"prebidServerURLInvalid","abstract":"\u003cp\u003eThe URL of the Prebid server is invalid.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidUnknownError":{"name":"prebidUnknownError","abstract":"\u003cp\u003eAn unknown error occurred within the Prebid SDK.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidResponseStructure":{"name":"prebidInvalidResponseStructure","abstract":"\u003cp\u003eThe structure of the response received is invalid.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInternalSDKError":{"name":"prebidInternalSDKError","abstract":"\u003cp\u003eAn internal error occurred within the SDK.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidWrongArguments":{"name":"prebidWrongArguments","abstract":"\u003cp\u003eIncorrect arguments were provided to the SDK.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidNoVastTagInMediaData":{"name":"prebidNoVastTagInMediaData","abstract":"\u003cp\u003eNo VAST tag was found in the media data.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidSDKMisuse":{"name":"prebidSDKMisuse","abstract":"\u003cp\u003eMisuse of the SDK was detected.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidSDKMisusePreviousFetchNotCompletedYet":{"name":"prebidSDKMisusePreviousFetchNotCompletedYet","abstract":"\u003cp\u003eSDK misuse due to a previous fetch operation not being completed yet.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/c:@M@PrebidMobile@E@ResultCode@ResultCodePrebidInvalidRequest":{"name":"prebidInvalidRequest","abstract":"\u003cp\u003eThe Prebid request does not contain any parameters.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/ResultCode.html#/s:12PrebidMobile10ResultCodeO4nameSSyF":{"name":"name()","abstract":"\u003cp\u003eReturns a descriptive name for the result code.\u003c/p\u003e","parent_name":"ResultCode"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionUndefined":{"name":"undefined","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionTopLeft":{"name":"topLeft","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionTopCenter":{"name":"topCenter","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionTopRight":{"name":"topRight","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionCenter":{"name":"center","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionBottomLeft":{"name":"bottomLeft","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionBottomCenter":{"name":"bottomCenter","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionBottomRight":{"name":"bottomRight","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/c:@M@PrebidMobile@E@PBMPosition@PBMPositionCustom":{"name":"custom","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Position"},"Enums/Position.html#/s:12PrebidMobile8PositionO03getC15ByStringLiteralyACSgSSFZ":{"name":"getPositionByStringLiteral(_:)","abstract":"\u003cp\u003eReturns the corresponding \u003ccode\u003ePosition\u003c/code\u003e enum value for a given string literal.\u003c/p\u003e","parent_name":"Position"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionUndefined":{"name":"undefined","abstract":"\u003cp\u003e0 Unknown\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionHeader":{"name":"header","abstract":"\u003cp\u003e4 Header\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionFooter":{"name":"footer","abstract":"\u003cp\u003e5 Footer\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionSidebar":{"name":"sidebar","abstract":"\u003cp\u003e6 Sidebar\u003c/p\u003e","parent_name":"AdPosition"},"Enums/AdPosition.html#/c:@M@PrebidMobile@E@PBMAdPosition@PBMAdPositionFullScreen":{"name":"fullScreen","abstract":"\u003cp\u003e7 Full Screen\u003c/p\u003e","parent_name":"AdPosition"},"Enums/PrebidHost.html#/c:@M@PrebidMobile@E@PrebidHost@PrebidHostAppnexus":{"name":"Appnexus","abstract":"\u003cp\u003eURL \u003ca href=\"URL\"\u003ehttps://ib.adnxs.com/openrtb2/prebid\u003c/a\u003e\u003c/p\u003e","parent_name":"PrebidHost"},"Enums/PrebidHost.html#/c:@M@PrebidMobile@E@PrebidHost@PrebidHostRubicon":{"name":"Rubicon","abstract":"\u003cp\u003eURL \u003ca href=\"URL\"\u003ehttps://prebid-server.rubiconproject.com/openrtb2/auction\u003c/a\u003e\u003c/p\u003e","parent_name":"PrebidHost"},"Enums/PrebidHost.html#/c:@M@PrebidMobile@E@PrebidHost@PrebidHostCustom":{"name":"Custom","abstract":"\u003cp\u003eCustom Prebid server URL. The URL for this case should be set separately.\u003c/p\u003e","parent_name":"PrebidHost"},"Enums/PrebidInitializationStatus.html#/c:@M@PrebidMobile@E@PrebidInitializationStatus@PrebidInitializationStatusSucceeded":{"name":"succeeded","abstract":"\u003cp\u003ePrebid SDK successfully initialized.\u003c/p\u003e","parent_name":"PrebidInitializationStatus"},"Enums/PrebidInitializationStatus.html#/c:@M@PrebidMobile@E@PrebidInitializationStatus@PrebidInitializationStatusFailed":{"name":"failed","abstract":"\u003cp\u003ePrebid SDK is not able to work.\u003c/p\u003e","parent_name":"PrebidInitializationStatus"},"Enums/PrebidInitializationStatus.html#/c:@M@PrebidMobile@E@PrebidInitializationStatus@PrebidInitializationStatusServerStatusWarning":{"name":"serverStatusWarning","abstract":"\u003cp\u003eSomething went wrong during PBS status checking.\u003c/p\u003e","parent_name":"PrebidInitializationStatus"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderUnknown":{"name":"unknown","abstract":"\u003cp\u003eGender is not specified or unknown.\u003c/p\u003e","parent_name":"Gender"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderMale":{"name":"male","abstract":"\u003cp\u003eRepresents the male gender.\u003c/p\u003e","parent_name":"Gender"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderFemale":{"name":"female","abstract":"\u003cp\u003eRepresents the female gender.\u003c/p\u003e","parent_name":"Gender"},"Enums/Gender.html#/c:@M@PrebidMobile@E@PBMGender@PBMGenderOther":{"name":"other","abstract":"\u003cp\u003eRepresents any other gender that does not fit into the male or female categories.\u003c/p\u003e","parent_name":"Gender"},"Enums/NativeImageAssetType.html#/c:@M@PrebidMobile@E@NativeImageAssetType@NativeImageAssetTypeIcon":{"name":"icon","abstract":"\u003cp\u003eRepresents an icon image, which is typically a small image used as a visual representation of the product or service.\u003c/p\u003e","parent_name":"NativeImageAssetType"},"Enums/NativeImageAssetType.html#/c:@M@PrebidMobile@E@NativeImageAssetType@NativeImageAssetTypeMain":{"name":"main","abstract":"\u003cp\u003eRepresents the main image of the ad, which is usually the primary visual element and central to the ad\u0026rsquo;s presentation.\u003c/p\u003e","parent_name":"NativeImageAssetType"},"Enums/NativeImageAssetType.html#/c:@M@PrebidMobile@E@NativeImageAssetType@NativeImageAssetTypeCustom":{"name":"custom","abstract":"\u003cp\u003eReserved for exchange-specific usage.\u003c/p\u003e","parent_name":"NativeImageAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeUndefined":{"name":"undefined","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeSponsored":{"name":"sponsored","abstract":"\u003cp\u003eSponsored By message where response should contain the brand name of the sponsor.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDesc":{"name":"desc","abstract":"\u003cp\u003eDescriptive text associated with the product or service being advertised. Longer length of text in response may be truncated or ellipsed by the exchange.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeRating":{"name":"rating","abstract":"\u003cp\u003eRating of the product being offered to the user. For example an app’s rating in an app store from 0-5.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeLikes":{"name":"likes","abstract":"\u003cp\u003eNumber of social ratings or “likes” of the product being offered to the user.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDownloads":{"name":"downloads","abstract":"\u003cp\u003eNumber downloads/installs of this product\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypePrice":{"name":"price","abstract":"\u003cp\u003ePrice for product / app / in-app purchase. Value should include currency symbol in localised format.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeSalePrice":{"name":"salePrice","abstract":"\u003cp\u003eSale price that can be used together with price to indicate a discounted price compared to a regular price. Value should include currency symbol in localised format.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypePhone":{"name":"phone","abstract":"\u003cp\u003ePhone number\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeAddress":{"name":"address","abstract":"\u003cp\u003eAddress\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDesc2":{"name":"desc2","abstract":"\u003cp\u003eAdditional descriptive text associated text with the product or service being advertised\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeDisplayURL":{"name":"displayURL","abstract":"\u003cp\u003eDisplay URL for the text ad. To be used when sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in this field).\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeCtaText":{"name":"ctaText","abstract":"\u003cp\u003eCTA description - descriptive text describing a ‘call to action’ button for the destination URL.\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/NativeDataAssetType.html#/c:@M@PrebidMobile@E@NativeDataAssetType@NativeDataAssetTypeCustom":{"name":"custom","abstract":"\u003cp\u003eReserved for Exchange specific usage numbered above 500\u003c/p\u003e","parent_name":"NativeDataAssetType"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetSponsored":{"name":"sponsored","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDescription":{"name":"description","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetRating":{"name":"rating","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetLikes":{"name":"likes","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDownloads":{"name":"downloads","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetPrice":{"name":"price","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetSaleprice":{"name":"saleprice","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetPhone":{"name":"phone","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetAddress":{"name":"address","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDescription2":{"name":"description2","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetDisplayurl":{"name":"displayurl","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetCtatext":{"name":"ctatext","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/c:@M@PrebidMobile@E@DataAsset@DataAssetCustom":{"name":"Custom","abstract":"\u003cp\u003eCustom type for user-defined data assets\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html#/s:12PrebidMobile9DataAssetO10exchangeIDSivp":{"name":"exchangeID","abstract":"\u003cp\u003eGets or sets the exchange ID for the asset type.\u003c/p\u003e","parent_name":"DataAsset"},"Enums/DataAsset.html":{"name":"DataAsset","abstract":"\u003cp\u003eEnum representing different types of native data assets.\u003c/p\u003e"},"Enums/NativeDataAssetType.html":{"name":"NativeDataAssetType","abstract":"\u003cp\u003eEnum representing various types of native data assets that can be used in ads.\u003c/p\u003e"},"Enums/NativeImageAssetType.html":{"name":"NativeImageAssetType","abstract":"\u003cp\u003eEnum representing various types of native image assets used in ads.\u003c/p\u003e"},"Enums/Gender.html":{"name":"Gender","abstract":"\u003cp\u003eAn enumeration representing gender options for ad targeting or other purposes."},"Enums/PrebidInitializationStatus.html":{"name":"PrebidInitializationStatus","abstract":"\u003cp\u003eEnum representing the initialization status of the Prebid SDK.\u003c/p\u003e"},"Enums/PrebidHost.html":{"name":"PrebidHost","abstract":"\u003cp\u003e\u003ccode\u003ePrebidHost\u003c/code\u003e represents various Prebid server hosts used for ad bidding.\u003c/p\u003e"},"Enums/AdPosition.html":{"name":"AdPosition","abstract":"\u003cp\u003eAd position on screen. Refer to List 5.4:"},"Enums/Position.html":{"name":"Position","abstract":"\u003cp\u003eEnum representing various positions on the screen.\u003c/p\u003e"},"Enums/ResultCode.html":{"name":"ResultCode","abstract":"\u003cp\u003eEnum representing the result codes for various operations within the Prebid SDK.\u003c/p\u003e"},"Classes/MediationRewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationRewardedAdUnit(im)initWithConfigId:mediationDelegate:":{"name":"init(configId:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new instance of the \u003ccode\u003eMediationRewardedAdUnit\u003c/code\u003e with the specified configuration ID and mediation delegate.\u003c/p\u003e","parent_name":"MediationRewardedAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(py)nativeAdUnit":{"name":"nativeAdUnit","abstract":"\u003cp\u003eThe native ad unit that makes native request.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)initWithConfigId:mediationDelegate:":{"name":"init(configId:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new instance of the \u003ccode\u003eMediationNativeAdUnit\u003c/code\u003e with the specified configuration ID and mediation delegate.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addEventTracker:":{"name":"addEventTracker(_:)","abstract":"\u003cp\u003eAdds event trackers to the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addNativeAssets:":{"name":"addNativeAssets(_:)","abstract":"\u003cp\u003eAdds native assets to the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setContextType:":{"name":"setContextType(_:)","abstract":"\u003cp\u003eSets the context type for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setPlacementType:":{"name":"setPlacementType(_:)","abstract":"\u003cp\u003eSets the placement type for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setPlacementCount:":{"name":"setPlacementCount(_:)","abstract":"\u003cp\u003eSets the placement count for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setContextSubType:":{"name":"setContextSubType(_:)","abstract":"\u003cp\u003eSets the context subtype for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setSequence:":{"name":"setSequence(_:)","abstract":"\u003cp\u003eSets the sequence for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setAssetURLSupport:":{"name":"setAssetURLSupport(_:)","abstract":"\u003cp\u003eSets the asset URL support for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setDURLSupport:":{"name":"setDURLSupport(_:)","abstract":"\u003cp\u003eSets the DURL support for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setPrivacy:":{"name":"setPrivacy(_:)","abstract":"\u003cp\u003eSets the privacy value for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setExt:":{"name":"setExt(_:)","abstract":"\u003cp\u003eSets the extended data for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)getOrtbConfig":{"name":"getOrtbConfig()","abstract":"\u003cp\u003eRetrieves the OpenRTB configuration for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setOrtbConfig:":{"name":"setOrtbConfig(_:)","abstract":"\u003cp\u003eSets the OpenRTB configuration for the native ad unit.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeAppContent:":{"name":"removeAppContent(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting.","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationNativeAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationNativeAdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request for the native ad unit and setups mediation parameters.\u003c/p\u003e","parent_name":"MediationNativeAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe ad format for the ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)additionalSizes":{"name":"additionalSizes","abstract":"\u003cp\u003eAdditional sizes for the ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)skipButtonArea":{"name":"skipButtonArea","abstract":"\u003cp\u003eThe area for the skip button in the video ad.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)skipButtonPosition":{"name":"skipButtonPosition","abstract":"\u003cp\u003eThe position of the skip button in the video ad.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)skipDelay":{"name":"skipDelay","abstract":"\u003cp\u003eThe delay before the skip button appears in the video ad.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(im)initWithConfigId:mediationDelegate:":{"name":"init(configId:mediationDelegate:)","abstract":"\u003cp\u003eConvenience initializer for the mediation interstitial ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/s:12PrebidMobile27MediationInterstitialAdUnitC8configId17minSizePercentage17mediationDelegateACSS_So6CGSizeVSgAA0acM0_ptcfc":{"name":"init(configId:minSizePercentage:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new mediation interstitial ad unit with the specified configuration ID, minimum size percentage, and mediation delegate.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationInterstitialAdUnit(py)configId":{"name":"configId","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"MediationInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eParameters for configuring banner ads.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eParameters for configuring video ads.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)isMuted":{"name":"isMuted","abstract":"\u003cp\u003eIndicates whether the video ad is muted.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)isSoundButtonVisible":{"name":"isSoundButtonVisible","abstract":"\u003cp\u003eIndicates whether the sound button is visible in the video ad.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)closeButtonArea":{"name":"closeButtonArea","abstract":"\u003cp\u003eThe area for the close button in the video ad.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)closeButtonPosition":{"name":"closeButtonPosition","abstract":"\u003cp\u003eThe position of the close button in the video ad.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eOpenRTB configuration for the ad unit.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(py)configId":{"name":"configId","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request and setups mediation parameters.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting.","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all content data objects from the app content.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBaseInterstitialAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"MediationBaseInterstitialAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)mediationDelegate":{"name":"mediationDelegate","abstract":"\u003cp\u003eProperty that performs certain utilty work for the \u003ccode\u003eMediationBannerAdUnit\u003c/code\u003e\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)configID":{"name":"configID","abstract":"\u003cp\u003eThe configuration ID for an ad unit\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)adFormat":{"name":"adFormat","abstract":"\u003cp\u003eThe ad format for the ad unit.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)adPosition":{"name":"adPosition","abstract":"\u003cp\u003eThe position of the ad on the screen.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eParameters for configuring banner ads.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eParameters for configuring video ads.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)refreshInterval":{"name":"refreshInterval","abstract":"\u003cp\u003eThe refresh interval for the ad.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)additionalSizes":{"name":"additionalSizes","abstract":"\u003cp\u003eAdditional sizes for the ad unit.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eOpenRTB configuration\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting.","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)getAppContent":{"name":"getAppContent()","abstract":"\u003cp\u003eRetrieves the current app content object.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all content data objects from the app content.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)initWithConfigID:size:mediationDelegate:":{"name":"init(configID:size:mediationDelegate:)","abstract":"\u003cp\u003eInitializes a new mediation banner ad unit with the specified configuration ID, size, and mediation delegate.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request and setups mediation parameters.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)stopRefresh":{"name":"stopRefresh()","abstract":"\u003cp\u003eStops the auto-refresh for the ad unit.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/MediationBannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)MediationBannerAdUnit(im)adObjectDidFailToLoadAdWithAdObject:with:":{"name":"adObjectDidFailToLoadAd(adObject:with:)","abstract":"\u003cp\u003eHandles the event when the ad object fails to load an ad.\u003c/p\u003e","parent_name":"MediationBannerAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(py)reward":{"name":"reward","abstract":"\u003cp\u003eThe reward object for the ad unit.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)initWithConfigID:eventHandler:":{"name":"init(configID:eventHandler:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedAdUnit\u003c/code\u003e with the given configuration ID and event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)initWithConfigID:":{"name":"init(configID:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedAdUnit\u003c/code\u003e with the given configuration ID and a default event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)userDidEarnReward:":{"name":"userDidEarnReward(_:)","abstract":"\u003cp\u003eCalled when the user earns a reward.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)interstitialControllerDidCloseAd:":{"name":"interstitialControllerDidCloseAd(_:)","abstract":"\u003cp\u003eCalled when the interstitial ad is closed.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didReceiveAd":{"name":"callDelegate_didReceiveAd()","abstract":"\u003cp\u003eCalled when the ad unit receives an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didFailToReceiveAdWith:":{"name":"callDelegate_didFailToReceiveAd(with:)","abstract":"\u003cp\u003eCalled when the ad unit fails to receive an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_willPresentAd":{"name":"callDelegate_willPresentAd()","abstract":"\u003cp\u003eCalled when the ad unit will present an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didDismissAd":{"name":"callDelegate_didDismissAd()","abstract":"\u003cp\u003eCalled when the ad unit dismisses an ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_willLeaveApplication":{"name":"callDelegate_willLeaveApplication()","abstract":"\u003cp\u003eCalled when the ad unit will leave the application.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callDelegate_didClickAd":{"name":"callDelegate_didClickAd()","abstract":"\u003cp\u003eCalled when the ad unit is clicked.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_isReady":{"name":"callEventHandler_isReady()","abstract":"\u003cp\u003eReturns whether the event handler is ready.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_setLoadingDelegate:":{"name":"callEventHandler_setLoadingDelegate(_:)","abstract":"\u003cp\u003eSets the loading delegate for the event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_setInteractionDelegate":{"name":"callEventHandler_setInteractionDelegate()","abstract":"\u003cp\u003eSets the interaction delegate for the event handler.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_requestAdWith:":{"name":"callEventHandler_requestAd(with:)","abstract":"\u003cp\u003eRequests an ad with the given bid response.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_showFrom:":{"name":"callEventHandler_show(from:)","abstract":"\u003cp\u003eShows the ad from the specified view controller.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/RewardedAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedAdUnit(im)callEventHandler_trackImpression":{"name":"callEventHandler_trackImpression()","abstract":"\u003cp\u003eTracks the impression for the ad.\u003c/p\u003e","parent_name":"RewardedAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(py)skipButtonArea":{"name":"skipButtonArea","abstract":"\u003cp\u003eThe area of the skip button in the video controls, specified as a percentage of the screen width.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(py)skipButtonPosition":{"name":"skipButtonPosition","abstract":"\u003cp\u003eThe position of the skip button in the video controls.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(py)skipDelay":{"name":"skipDelay","abstract":"\u003cp\u003eThe delay before the skip button appears, in seconds.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)initWithConfigID:":{"name":"init(configID:)","abstract":"\u003cp\u003eInitializes a new interstitial rendering ad unit with the specified configuration ID.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)initWithConfigID:minSizePercentage:":{"name":"init(configID:minSizePercentage:)","abstract":"\u003cp\u003eInitializes a new interstitial rendering ad unit with the specified configuration ID and minimum size percentage.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)initWithConfigID:minSizePercentage:eventHandler:":{"name":"init(configID:minSizePercentage:eventHandler:)","abstract":"\u003cp\u003eInitializes a new interstitial rendering ad unit with the specified configuration ID, minimum size percentage, and event handler.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didReceiveAd":{"name":"callDelegate_didReceiveAd()","abstract":"\u003cp\u003eCalled when an ad is successfully received.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didFailToReceiveAdWith:":{"name":"callDelegate_didFailToReceiveAd(with:)","abstract":"\u003cp\u003eCalled when the ad fails to be received.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_willPresentAd":{"name":"callDelegate_willPresentAd()","abstract":"\u003cp\u003eCalled when the ad will be presented.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didDismissAd":{"name":"callDelegate_didDismissAd()","abstract":"\u003cp\u003eCalled when the ad is dismissed.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_willLeaveApplication":{"name":"callDelegate_willLeaveApplication()","abstract":"\u003cp\u003eCalled when the user will leave the application.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callDelegate_didClickAd":{"name":"callDelegate_didClickAd()","abstract":"\u003cp\u003eCalled when the ad is clicked.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_isReady":{"name":"callEventHandler_isReady()","abstract":"\u003cp\u003eChecks if the ad is ready to be displayed.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_setLoadingDelegate:":{"name":"callEventHandler_setLoadingDelegate(_:)","abstract":"\u003cp\u003eSets the loading delegate for the event handler.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_setInteractionDelegate":{"name":"callEventHandler_setInteractionDelegate()","abstract":"\u003cp\u003eSets the interaction delegate for the event handler.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_requestAdWith:":{"name":"callEventHandler_requestAd(with:)","abstract":"\u003cp\u003eRequests an ad with the specified bid response\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_showFrom:":{"name":"callEventHandler_show(from:)","abstract":"\u003cp\u003eShows the ad from the specified view controller.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/InterstitialRenderingAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit(im)callEventHandler_trackImpression":{"name":"callEventHandler_trackImpression()","abstract":"\u003cp\u003eTracks an impression for the ad.\u003c/p\u003e","parent_name":"InterstitialRenderingAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eThe banner parameters used for configuring ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video parameters used for configuring ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)lastBidResponse":{"name":"lastBidResponse","abstract":"\u003cp\u003eThe last bid response received for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)configID":{"name":"configID","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe set of ad formats supported by this ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eThe ORTB (OpenRTB) configuration string for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)isReady":{"name":"isReady","abstract":"\u003cp\u003eA Boolean value indicating whether the ad unit is ready to be displayed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)isMuted":{"name":"isMuted","abstract":"\u003cp\u003eA Boolean value indicating whether the video controls are muted.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)isSoundButtonVisible":{"name":"isSoundButtonVisible","abstract":"\u003cp\u003eA Boolean value indicating whether the sound button is visible in the video controls.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)closeButtonArea":{"name":"closeButtonArea","abstract":"\u003cp\u003eThe area of the close button in the video controls as a percentage.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)closeButtonPosition":{"name":"closeButtonPosition","abstract":"\u003cp\u003eThe position of the close button in the video controls.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eA delegate for handling interactions with the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)adUnitConfig":{"name":"adUnitConfig","abstract":"\u003cp\u003eThe configuration object for the ad unit.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID11minSizePerc12eventHandlerACSS_So7NSValueCSgyXlSgtcfc":{"name":"init(configID:minSizePerc:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID, minimum size percentage, and event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID17minSizePercentage12eventHandlerACSS_So6CGSizeVyXlSgtcfc":{"name":"init(configID:minSizePercentage:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID, minimum size percentage, and event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID12eventHandlerACSS_yXlSgtcfc":{"name":"init(configID:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID and event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configID17minSizePercentageACSS_So6CGSizeVtcfc":{"name":"init(configID:minSizePercentage:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID and minimum size percentage.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC8configIDACSS_tcfc":{"name":"init(configID:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBaseInterstitialAdUnit\u003c/code\u003e with the specified configuration ID.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)loadAd":{"name":"loadAd()","abstract":"\u003cp\u003eLoads a new ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)showFrom:":{"name":"show(from:)","abstract":"\u003cp\u003eShows the ad from a specified view controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addContextData:forKey:":{"name":"addContextData(_:forKey:)","abstract":"\u003cp\u003eAdds context data for a specified key.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)updateContextData:forKey:":{"name":"updateContextData(_:forKey:)","abstract":"\u003cp\u003eUpdates context data for a specified key.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeContextDateForKey:":{"name":"removeContextDate(forKey:)","abstract":"\u003cp\u003eRemoves context data for a specified key.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eClears all context data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eAdds ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eUpdates ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eRemoves ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eClears ext data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eAdds a context keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eAdds a set of context keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eRemoves a context keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eClears all context keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eAdds an extended keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eAdds multiple extended keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eRemoves an extended keyword.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eClears all extended keywords.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the app content data.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds app content data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeAppContentDataObject:":{"name":"removeAppContentDataObject(_:)","abstract":"\u003cp\u003eRemoves an app content data object.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearAppContentDataObjects":{"name":"clearAppContentDataObjects()","abstract":"\u003cp\u003eClears all app content data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds user data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a user data object.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data objects.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialAdLoader:loadedAd:isReadyBlock:":{"name":"interstitialAdLoader(_:loadedAd:isReadyBlock:)","abstract":"\u003cp\u003eInternal delegate method.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialAdLoader:createdInterstitialController:":{"name":"interstitialAdLoader(_:createdInterstitialController:)","abstract":"\u003cp\u003eInternal delegate method.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(py)eventHandler":{"name":"eventHandler","abstract":"\u003cp\u003eThe event handler for the interstitial events.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowControllerWillSendBidRequest:":{"name":"adLoadFlowControllerWillSendBidRequest(_:)","abstract":"\u003cp\u003eCalled when the ad load flow controller is about to send a bid request.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowControllerWillRequestPrimaryAd:":{"name":"adLoadFlowControllerWillRequestPrimaryAd(_:)","abstract":"\u003cp\u003eCalled when the ad load flow controller is about to request the primary ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowControllerShouldContinue:":{"name":"adLoadFlowControllerShouldContinue(_:)","abstract":"\u003cp\u003eCalled to determine if the ad load flow controller should continue with the current flow.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)adLoadFlowController:failedWithError:":{"name":"adLoadFlowController(_:failedWithError:)","abstract":"\u003cp\u003eCalled when the ad load flow controller fails with an error.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)trackImpressionForInterstitialController:":{"name":"trackImpression(forInterstitialController:)","abstract":"\u003cp\u003eTracks an impression for the given interstitial controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidClickAd:":{"name":"interstitialControllerDidClickAd(_:)","abstract":"\u003cp\u003eCalled when the ad in the interstitial controller is clicked.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidCloseAd:":{"name":"interstitialControllerDidCloseAd(_:)","abstract":"\u003cp\u003eCalled when the ad in the interstitial controller is closed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidLeaveApp:":{"name":"interstitialControllerDidLeaveApp(_:)","abstract":"\u003cp\u003eCalled when the ad in the interstitial controller causes the app to leave.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidDisplay:":{"name":"interstitialControllerDidDisplay(_:)","abstract":"\u003cp\u003eCalled when the interstitial controller displays an ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)interstitialControllerDidComplete:":{"name":"interstitialControllerDidComplete(_:)","abstract":"\u003cp\u003eCalled when the interstitial controller completes the ad display.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)viewControllerForModalPresentationFromInterstitialController:":{"name":"viewControllerForModalPresentation(fromInterstitialController:)","abstract":"\u003cp\u003eProvides the view controller to use for modal presentation.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)willPresentAd":{"name":"willPresentAd()","abstract":"\u003cp\u003eCalled when an ad is about to be presented.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)didDismissAd":{"name":"didDismissAd()","abstract":"\u003cp\u003eCalled when an ad has been dismissed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)willLeaveApp":{"name":"willLeaveApp()","abstract":"\u003cp\u003eCalled when the ad causes the app to leave.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)didClickAd":{"name":"didClickAd()","abstract":"\u003cp\u003eCalled when an ad is clicked.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_requestAdWith:":{"name":"callEventHandler_requestAd(with:)","abstract":"\u003cp\u003eRequests an ad using the provided bid response.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_showFrom:":{"name":"callEventHandler_show(from:)","abstract":"\u003cp\u003eDisplays the ad using the provided view controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_isReady":{"name":"callEventHandler_isReady()","abstract":"\u003cp\u003eChecks if the ad unit is ready to show an ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didReceiveAd":{"name":"callDelegate_didReceiveAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad has been successfully received.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didFailToReceiveAdWith:":{"name":"callDelegate_didFailToReceiveAd(with:)","abstract":"\u003cp\u003eNotifies the delegate that the ad failed to load.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_willPresentAd":{"name":"callDelegate_willPresentAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad is about to be presented.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didDismissAd":{"name":"callDelegate_didDismissAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad has been dismissed.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_willLeaveApplication":{"name":"callDelegate_willLeaveApplication()","abstract":"\u003cp\u003eNotifies the delegate that the app is about to leave due to an ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callDelegate_didClickAd":{"name":"callDelegate_didClickAd()","abstract":"\u003cp\u003eNotifies the delegate that an ad has been clicked.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_setLoadingDelegate:":{"name":"callEventHandler_setLoadingDelegate(_:)","abstract":"\u003cp\u003eSets the loading delegate for the event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_setInteractionDelegate":{"name":"callEventHandler_setInteractionDelegate()","abstract":"\u003cp\u003eSets the interaction delegate for the event handler.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/s:12PrebidMobile22BaseInterstitialAdUnitC39callEventHandler_showFromViewController10controllerySo06UIViewM0CSg_tF":{"name":"callEventHandler_showFromViewController(controller:)","abstract":"\u003cp\u003eShows the ad from the provided view controller.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BaseInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit(im)callEventHandler_trackImpression":{"name":"callEventHandler_trackImpression()","abstract":"\u003cp\u003eTracks an impression for the ad.\u003c/p\u003e","parent_name":"BaseInterstitialAdUnit"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)adUnitConfig":{"name":"adUnitConfig","abstract":"\u003cp\u003eThe ad unit configuration.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)eventHandler":{"name":"eventHandler","abstract":"\u003cp\u003eThe event handler for banner view events.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eBanner-specific parameters.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eVideo-specific parameters.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)lastBidResponse":{"name":"lastBidResponse","abstract":"\u003cp\u003eThe last bid response received.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)configID":{"name":"configID","abstract":"\u003cp\u003eID of Stored Impression on the Prebid server\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)refreshInterval":{"name":"refreshInterval","abstract":"\u003cp\u003eThe interval for refreshing the ad.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)additionalSizes":{"name":"additionalSizes","abstract":"\u003cp\u003eAdditional sizes for the ad.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)adFormat":{"name":"adFormat","abstract":"\u003cp\u003eThe ad format (e.g., banner, video).\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)adPosition":{"name":"adPosition","abstract":"\u003cp\u003eThe position of the ad on the screen.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)ortbConfig":{"name":"ortbConfig","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eORTB configuration string.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)initWithFrame:configID:adSize:eventHandler:":{"name":"init(frame:configID:adSize:eventHandler:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBannerView\u003c/code\u003e.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)initWithConfigID:eventHandler:":{"name":"init(configID:eventHandler:)","abstract":"\u003cp\u003eConvenience initializer for creating a \u003ccode\u003eBannerView\u003c/code\u003e with a configuration ID and event handler.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)initWithFrame:configID:adSize:":{"name":"init(frame:configID:adSize:)","abstract":"\u003cp\u003eConvenience initializer for creating a \u003ccode\u003eBannerView\u003c/code\u003e with a frame, configuration ID, and ad size.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)loadAd":{"name":"loadAd()","abstract":"\u003cp\u003eLoads the ad for the banner view.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)setStoredAuctionResponseWithStoredAuction:":{"name":"setStoredAuctionResponse(storedAuction:)","abstract":"\u003cp\u003eSets the stored auction response.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)stopRefresh":{"name":"stopRefresh()","abstract":"\u003cp\u003eStops the auto-refresh of the ad.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addContextData:forKey:":{"name":"addContextData(_:forKey:)","abstract":"\u003cp\u003eAdds context data for a specified key.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)updateContextData:forKey:":{"name":"updateContextData(_:forKey:)","abstract":"\u003cp\u003eUpdates context data for a specified key.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeContextDateForKey:":{"name":"removeContextDate(forKey:)","abstract":"\u003cp\u003eRemoves context data for a specified key.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eClears all context data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eAdds ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eUpdates ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eRemoves ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eClears ext data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eAdds a context keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eAdds a set of context keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eRemoves a context keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eClears all context keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eAdds an extended keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eAdds multiple extended keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eRemoves an extended keyword.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eClears all extended keywords.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the app content data.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds app content data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeAppContentDataObject:":{"name":"removeAppContentDataObject(_:)","abstract":"\u003cp\u003eRemoves an app content data object.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearAppContentDataObjects":{"name":"clearAppContentDataObjects()","abstract":"\u003cp\u003eClears all app content data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds user data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a user data object.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data objects.\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)trackImpressionForDisplayView:":{"name":"trackImpression(forDisplayView:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)viewControllerForModalPresentationFromDisplayView:":{"name":"viewControllerForModalPresentation(fromDisplayView:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)didLeaveAppFrom:":{"name":"didLeaveApp(from:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)willPresentModalFrom:":{"name":"willPresentModal(from:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)didDismissModalFrom:":{"name":"didDismissModal(from:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)bannerAdLoader:loadedAdView:adSize:":{"name":"bannerAdLoader(_:loadedAdView:adSize:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)bannerAdLoader:createdDisplayView:":{"name":"bannerAdLoader(_:createdDisplayView:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowController:failedWithError:":{"name":"adLoadFlowController(_:failedWithError:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowControllerWillSendBidRequest:":{"name":"adLoadFlowControllerWillSendBidRequest(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowControllerWillRequestPrimaryAd:":{"name":"adLoadFlowControllerWillRequestPrimaryAd(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)adLoadFlowControllerShouldContinue:":{"name":"adLoadFlowControllerShouldContinue(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)willPresentModal":{"name":"willPresentModal()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)didDismissModal":{"name":"didDismissModal()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(im)willLeaveApp":{"name":"willLeaveApp()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/BannerView.html#/c:@M@PrebidMobile@objc(cs)BannerView(py)viewControllerForPresentingModal":{"name":"viewControllerForPresentingModal","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"BannerView"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)maxVideoDuration":{"name":"maxVideoDuration","abstract":"\u003cp\u003eThis property indicates maximum video duration.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)isMuted":{"name":"isMuted","abstract":"\u003cp\u003eThis property indicates whether the ad should run playback with sound or not.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)closeButtonArea":{"name":"closeButtonArea","abstract":"\u003cp\u003eThis property indicates the area which the close button should occupy on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)closeButtonPosition":{"name":"closeButtonPosition","abstract":"\u003cp\u003eThis property indicates the position of the close button on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)skipButtonArea":{"name":"skipButtonArea","abstract":"\u003cp\u003eThis property indicates the area which the skip button should occupy on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)skipButtonPosition":{"name":"skipButtonPosition","abstract":"\u003cp\u003eThis property indicates the position of the skip button on the screen.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)skipDelay":{"name":"skipDelay","abstract":"\u003cp\u003eThis property indicates the number of seconds which should be passed from the start of playback until the skip or close button should be shown.","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(py)isSoundButtonVisible":{"name":"isSoundButtonVisible","abstract":"\u003cp\u003eThis property indicates whether mute controls is visible on the screen.\u003c/p\u003e","parent_name":"VideoControlsConfiguration"},"Classes/VideoControlsConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMVideoControlsConfiguration(im)initializeWith:":{"name":"initialize(with:)","abstract":"\u003cp\u003eUse to initialize video controls with server values.\u003c/p\u003e","parent_name":"VideoControlsConfiguration"},"Classes/AdFormat.html#/s:12PrebidMobile8AdFormatC8RawValuea":{"name":"RawValue","abstract":"\u003cp\u003eThe underlying type of the raw value.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(py)rawValue":{"name":"rawValue","abstract":"\u003cp\u003eThe raw integer value representing the ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(py)stringEquivalent":{"name":"stringEquivalent","abstract":"\u003cp\u003eThe string representation of the ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(im)initWithRawValue:stringEquivalent:":{"name":"init(rawValue:stringEquivalent:)","abstract":"\u003cp\u003eInitializes an \u003ccode\u003eAdFormat\u003c/code\u003e instance with a specified raw value and its string equivalent.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(im)initWithRawValue:":{"name":"init(rawValue:)","abstract":"\u003cp\u003eInitializes an \u003ccode\u003eAdFormat\u003c/code\u003e instance with a specified raw value.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)banner":{"name":"banner","abstract":"\u003cp\u003eRepresents a banner ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)video":{"name":"video","abstract":"\u003cp\u003eRepresents a video ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)native":{"name":"native","abstract":"\u003cp\u003eRepresents a native ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)display":{"name":"display","abstract":"\u003cp\u003eRepresents a deprecated display ad format.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/AdFormat.html#/c:@M@PrebidMobile@objc(cs)AdFormat(cpy)allCases":{"name":"allCases","abstract":"\u003cp\u003eAn array containing all cases of ad formats, excluding deprecated ones.\u003c/p\u003e","parent_name":"AdFormat"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eThe class is created as a singleton object \u0026amp; used\u003c/p\u003e","parent_name":"Host"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(im)setCustomHostURL:error:":{"name":"setCustomHostURL(_:)","abstract":"\u003cp\u003eThe CustomHost property holds the URL for the custom prebid adaptor\u003c/p\u003e","parent_name":"Host"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(im)getHostURLWithHost:error:":{"name":"getHostURL(host:)","abstract":"\u003cp\u003eThis function retrieves the prebid server URL for the selected host\u003c/p\u003e","parent_name":"Host"},"Classes/Host.html#/c:@M@PrebidMobile@objc(cs)Host(im)verifyUrlWithUrlString:":{"name":"verifyUrl(urlString:)","abstract":"\u003cp\u003eThis function verifies if the prebid server URL is in the url format\u003c/p\u003e","parent_name":"Host"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(cpy)supportsSecureCoding":{"name":"supportsSecureCoding","abstract":"\u003cp\u003eIndicates whether the class supports secure coding.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)source":{"name":"source","abstract":"\u003cp\u003eThe source of the external user ID.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)identifier":{"name":"identifier","abstract":"\u003cp\u003eThe identifier of the external user ID.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)atype":{"name":"atype","abstract":"\u003cp\u003eThe type of the external user ID, represented as an optional \u003ccode\u003eNSNumber\u003c/code\u003e.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional attributes related to the external user ID, represented as an optional dictionary.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)initWithSource:identifier:atype:ext:":{"name":"init(source:identifier:atype:ext:)","abstract":"\u003cp\u003eInitialize ExternalUserId Class\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)encodeWithCoder:":{"name":"encode(with:)","abstract":"\u003cp\u003eEncodes the properties of the class using the given encoder.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)initWithCoder:":{"name":"init(coder:)","abstract":"\u003cp\u003eInitializes an \u003ccode\u003eExternalUserId\u003c/code\u003e instance from the given decoder.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/ExternalUserId.html#/c:@M@PrebidMobile@objc(cs)ExternalUserId(im)toJSONDictionary":{"name":"toJSONDictionary()","abstract":"\u003cp\u003eConverts the \u003ccode\u003eExternalUserId\u003c/code\u003e instance to a JSON dictionary.\u003c/p\u003e","parent_name":"ExternalUserId"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eA shared instance of the \u003ccode\u003eTargeting\u003c/code\u003e class.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)omidPartnerName":{"name":"omidPartnerName","abstract":"\u003cp\u003eThe name of the OMID partner.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)omidPartnerVersion":{"name":"omidPartnerVersion","abstract":"\u003cp\u003eThe version of the OMID partner.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)yearOfBirth":{"name":"yearOfBirth","abstract":"\u003cp\u003eIndicates user birth year.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setYearOfBirthWithYob:":{"name":"setYearOfBirth(yob:)","abstract":"\u003cp\u003eThis method set the year of birth value\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getYearOfBirth":{"name":"getYearOfBirth()","abstract":"\u003cp\u003eObjective C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearYearOfBirth":{"name":"clearYearOfBirth()","abstract":"\u003cp\u003eThis method clears year of birth value set by the application developer\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userGender":{"name":"userGender","abstract":"\u003cp\u003eIndicates the end-user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)userGenderDescription":{"name":"userGenderDescription()","abstract":"\u003cp\u003eString representation of the users gender,","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userID":{"name":"userID","abstract":"\u003cp\u003eIndicates the customer-provided user ID, if different from the Device ID.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)buyerUID":{"name":"buyerUID","abstract":"\u003cp\u003eBuyer-specific ID for the user as mapped by the exchange for the buyer.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userCustomData":{"name":"userCustomData","abstract":"\u003cp\u003eOptional feature to pass bidder data that was set in the","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)eids":{"name":"eids","abstract":"\u003cp\u003ePlaceholder for User Identity Links.","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userExt":{"name":"userExt","abstract":"\u003cp\u003ePlaceholder for exchange-specific extensions to OpenRTB.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)coppa":{"name":"coppa","abstract":"\u003cp\u003eObjective C analog of subjectToCOPPA\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC14subjectToCOPPASbSgvp":{"name":"subjectToCOPPA","abstract":"\u003cp\u003eInteger flag indicating if this request is subject to the COPPA regulations","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC13subjectToGDPRSbSgvp":{"name":"subjectToGDPR","abstract":"\u003cp\u003eThe boolean value set by the user to collect user data\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setSubjectToGDPR:":{"name":"setSubjectToGDPR(_:)","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getSubjectToGDPR":{"name":"getSubjectToGDPR()","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)gdprConsentString":{"name":"gdprConsentString","abstract":"\u003cp\u003eThe consent string for sending the GDPR consent\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)purposeConsents":{"name":"purposeConsents","abstract":"\u003cp\u003eThe consent string for purposes consent as per TCFv2.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC22getDeviceAccessConsentSbSgyF":{"name":"getDeviceAccessConsent()","abstract":"\u003cp\u003ePurpose 1 - Store and/or access information on a device\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getDeviceAccessConsentObjc":{"name":"getDeviceAccessConsentObjc()","abstract":"\u003cp\u003eReturns whether the user has consented to access device data as an \u003ccode\u003eNSNumber\u003c/code\u003e.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC17getPurposeConsent5indexSbSgSi_tF":{"name":"getPurposeConsent(index:)","abstract":"\u003cp\u003eReturns the user\u0026rsquo;s consent for a specific purpose by index.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)isAllowedAccessDeviceData":{"name":"isAllowedAccessDeviceData()","abstract":"\u003cp\u003eChecks if access to device data is allowed.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)externalUserIds":{"name":"externalUserIds","abstract":"\u003cp\u003eArray of external user IDs.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)storeExternalUserId:":{"name":"storeExternalUserId(_:)","abstract":"\u003cp\u003eThis method allows to save External User Id in the User Defaults\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)fetchStoredExternalUserIds":{"name":"fetchStoredExternalUserIds()","abstract":"\u003cp\u003eThis method allows to get All External User Ids from User Defaults\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)fetchStoredExternalUserId:":{"name":"fetchStoredExternalUserId(_:)","abstract":"\u003cp\u003eThis method allows to get External User Id from User Defaults by passing respective \u0026lsquo;source\u0026rsquo; string as param\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeStoredExternalUserId:":{"name":"removeStoredExternalUserId(_:)","abstract":"\u003cp\u003eThis method allows to remove specific External User Id from User Defaults by passing respective \u0026lsquo;source\u0026rsquo; string as param\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeStoredExternalUserIds":{"name":"removeStoredExternalUserIds()","abstract":"\u003cp\u003eThis method allows to remove all the External User Ids from User Defaults\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getExternalUserIds":{"name":"getExternalUserIds()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)contentUrl":{"name":"contentUrl","abstract":"\u003cp\u003eThis is the deep-link URL for the app screen that is displaying the ad. This can be an iOS universal link.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)publisherName":{"name":"publisherName","abstract":"\u003cp\u003eApp\u0026rsquo;s publisher name.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)sourceapp":{"name":"sourceapp","abstract":"\u003cp\u003eID of publisher app in Apple’s App Store.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)storeURL":{"name":"storeURL","abstract":"\u003cp\u003eApp store URL for an installed app\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)domain":{"name":"domain","abstract":"\u003cp\u003eDomain name of the app\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)itunesID":{"name":"itunesID","abstract":"\u003cp\u003eThe itunes app id for targeting\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)location":{"name":"location","abstract":"\u003cp\u003eThe application location for targeting\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/s:12PrebidMobile9TargetingC17locationPrecisionSiSgvp":{"name":"locationPrecision","abstract":"\u003cp\u003eThe application location precision for targeting\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setLocationPrecision:":{"name":"setLocationPrecision(_:)","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getLocationPrecision":{"name":"getLocationPrecision()","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)coordinate":{"name":"coordinate","abstract":"\u003cp\u003eCLLocationCoordinate2D.","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addParam:withName:":{"name":"addParam(_:withName:)","abstract":"\u003cp\u003eAdds a parameter to the parameter dictionary with a specified name.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setCustomParams:":{"name":"setCustomParams(_:)","abstract":"\u003cp\u003eSets custom parameters by adding each key-value pair to the parameter dictionary.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addCustomParam:withName:":{"name":"addCustomParam(_:withName:)","abstract":"\u003cp\u003eAdds a custom parameter to the parameter dictionary with a prefixed name.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)setLatitude:longitude:":{"name":"setLatitude(_:longitude:)","abstract":"\u003cp\u003eStore location in the user\u0026rsquo;s section\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addBidderToAccessControlList:":{"name":"addBidderToAccessControlList(_:)","abstract":"\u003cp\u003eAdds a bidder to the access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeBidderFromAccessControlList:":{"name":"removeBidderFromAccessControlList(_:)","abstract":"\u003cp\u003eRemoves a bidder from the access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearAccessControlList":{"name":"clearAccessControlList()","abstract":"\u003cp\u003eClears all bidders from the access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getAccessControlList":{"name":"getAccessControlList()","abstract":"\u003cp\u003eRetrieves the current access control list.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)accessControlList":{"name":"accessControlList","abstract":"\u003cp\u003eAccess control list for external use.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addUserDataWithKey:value:":{"name":"addUserData(key:value:)","abstract":"\u003cp\u003eAdds user data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)updateUserDataWithKey:value:":{"name":"updateUserData(key:value:)","abstract":"\u003cp\u003eUpdates user data for a specified key with a new set of values.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeUserDataFor:":{"name":"removeUserData(for:)","abstract":"\u003cp\u003eRemoves user data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getUserData":{"name":"getUserData()","abstract":"\u003cp\u003eRetrieves all user data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userDataDictionary":{"name":"userDataDictionary","abstract":"\u003cp\u003eUser data dictionary for external use.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addUserKeyword:":{"name":"addUserKeyword(_:)","abstract":"\u003cp\u003eAdds a user keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addUserKeywords:":{"name":"addUserKeywords(_:)","abstract":"\u003cp\u003eAdds multiple user keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeUserKeyword:":{"name":"removeUserKeyword(_:)","abstract":"\u003cp\u003eRemoves a user keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearUserKeywords":{"name":"clearUserKeywords()","abstract":"\u003cp\u003eClears all user keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getUserKeywords":{"name":"getUserKeywords()","abstract":"\u003cp\u003eRetrieves all user keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)userKeywords":{"name":"userKeywords","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetUserKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eaddAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eupdateAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeContextDataFor:":{"name":"removeContextData(for:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eremoveAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eclearAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getContextData":{"name":"getContextData()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)contextDataDictionary":{"name":"contextDataDictionary","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppExtData\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addAppExtDataWithKey:value:":{"name":"addAppExtData(key:value:)","abstract":"\u003cp\u003eAdds application-specific data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)updateAppExtDataWithKey:value:":{"name":"updateAppExtData(key:value:)","abstract":"\u003cp\u003eUpdates application-specific data for a specified key with a new set of values.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeAppExtDataFor:":{"name":"removeAppExtData(for:)","abstract":"\u003cp\u003eRemoves application-specific data for a specified key.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearAppExtData":{"name":"clearAppExtData()","abstract":"\u003cp\u003eClears all application-specific data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getAppExtData":{"name":"getAppExtData()","abstract":"\u003cp\u003eRetrieves all application-specific data.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eaddAppKeyword\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eaddAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eremoveAppKeyword\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003eclearAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getContextKeywords":{"name":"getContextKeywords()","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)contextKeywords":{"name":"contextKeywords","abstract":"\u003cp\u003eDeprecated. Use \u003ccode\u003egetAppKeywords\u003c/code\u003e method instead.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addAppKeyword:":{"name":"addAppKeyword(_:)","abstract":"\u003cp\u003eAdds an application keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)addAppKeywords:":{"name":"addAppKeywords(_:)","abstract":"\u003cp\u003eAdds multiple application keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)removeAppKeyword:":{"name":"removeAppKeyword(_:)","abstract":"\u003cp\u003eRemoves an application keyword.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)clearAppKeywords":{"name":"clearAppKeywords()","abstract":"\u003cp\u003eClears all application keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(im)getAppKeywords":{"name":"getAppKeywords()","abstract":"\u003cp\u003eRetrieves all application keywords.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Targeting.html#/c:@M@PrebidMobile@objc(cs)Targeting(py)parameterDictionary":{"name":"parameterDictionary","abstract":"\u003cp\u003eDictionary of parameters.\u003c/p\u003e","parent_name":"Targeting"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cpy)bidderNameAppNexus":{"name":"bidderNameAppNexus","abstract":"\u003cp\u003eThe name of the bidder for AppNexus.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cpy)bidderNameRubiconProject":{"name":"bidderNameRubiconProject","abstract":"\u003cp\u003eThe name of the bidder for Rubicon Project.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)timeoutUpdated":{"name":"timeoutUpdated","abstract":"\u003cp\u003eIndicates whether the timeout value has been updated.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)prebidServerAccountId":{"name":"prebidServerAccountId","abstract":"\u003cp\u003eThe Prebid Server account ID.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)pbsDebug":{"name":"pbsDebug","abstract":"\u003cp\u003eEnables or disables debug mode.","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)customHeaders":{"name":"customHeaders","abstract":"\u003cp\u003eCustom HTTP headers to be sent with requests.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)storedBidResponses":{"name":"storedBidResponses","abstract":"\u003cp\u003eStored bid responses identified by bidder names.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)shouldAssignNativeAssetID":{"name":"shouldAssignNativeAssetID","abstract":"\u003cp\u003eThis property is set by the developer when he is willing to assign the assetID for Native ad.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)shareGeoLocation":{"name":"shareGeoLocation","abstract":"\u003cp\u003eThis property is set by the developer when he is willing to share the location for better ad targeting\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)logLevel":{"name":"logLevel","abstract":"\u003cp\u003eSet the desidered verbosity of the logs\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)externalUserIdArray":{"name":"externalUserIdArray","abstract":"\u003cp\u003eArray containing objects that hold External UserId parameters.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eThe singleton instance of the \u003ccode\u003ePrebid\u003c/code\u003e class.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)version":{"name":"version","abstract":"\u003cp\u003eThe version of the PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)omsdkVersion":{"name":"omsdkVersion","abstract":"\u003cp\u003eThe version of the OM SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)prebidServerHost":{"name":"prebidServerHost","abstract":"\u003cp\u003eThe host for the Prebid Server.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)customStatusEndpoint":{"name":"customStatusEndpoint","abstract":"\u003cp\u003eCustom status endpoint for the Prebid Server.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)timeoutMillis":{"name":"timeoutMillis","abstract":"\u003cp\u003eTimeout for Prebid requests in milliseconds.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)timeoutMillisDynamic":{"name":"timeoutMillisDynamic","abstract":"\u003cp\u003eDynamic timeout value.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)storedAuctionResponse":{"name":"storedAuctionResponse","abstract":"\u003cp\u003eStored auction response.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)useCacheForReportingWithRenderingAPI":{"name":"useCacheForReportingWithRenderingAPI","abstract":"\u003cp\u003eIndicates whether the PBS should cache the bid for the rendering API.","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)creativeFactoryTimeout":{"name":"creativeFactoryTimeout","abstract":"\u003cp\u003eControls how long each creative has to load before it is considered a failure.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)creativeFactoryTimeoutPreRenderContent":{"name":"creativeFactoryTimeoutPreRenderContent","abstract":"\u003cp\u003eControls how long video and interstitial creatives have to load before it is considered a failure.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)useExternalClickthroughBrowser":{"name":"useExternalClickthroughBrowser","abstract":"\u003cp\u003eControls whether to use PrebidMobile\u0026rsquo;s in-app browser or the Safari App for displaying ad clickthrough content.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)impClickbrowserType":{"name":"impClickbrowserType","abstract":"\u003cp\u003eIndicates the type of browser opened upon clicking the creative in an app, where embedded = 0, native = 1.","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)debugLogFileEnabled":{"name":"debugLogFileEnabled","abstract":"\u003cp\u003eIf set to true, the output of PrebidMobile\u0026rsquo;s internal logger is written to a text file. This can be helpful for debugging. Defaults to false.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)locationUpdatesEnabled":{"name":"locationUpdatesEnabled","abstract":"\u003cp\u003eIf true, the SDK will periodically try to listen for location updates in order to request location-based ads.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)includeWinners":{"name":"includeWinners","abstract":"\u003cp\u003eIf true, the sdk will add \u003ccode\u003eincludewinners\u003c/code\u003e flag inside the targeting object described in \u003ca href=\"https://docs.prebid.org/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#targeting\"\u003ePBS Documentation\u003c/a\u003e\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(py)includeBidderKeys":{"name":"includeBidderKeys","abstract":"\u003cp\u003eIf true, the sdk will add \u003ccode\u003eincludebidderkeys\u003c/code\u003e flag inside the targeting object described in \u003ca href=\"https://docs.prebid.org/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#targeting\"\u003ePBS Documentation\u003c/a\u003e\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)setCustomPrebidServerWithUrl:error:":{"name":"setCustomPrebidServer(url:)","abstract":"\u003cp\u003eSets a custom Prebid Server URL.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)addStoredBidResponseWithBidder:responseId:":{"name":"addStoredBidResponse(bidder:responseId:)","abstract":"\u003cp\u003eAdds a stored bid response.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)clearStoredBidResponses":{"name":"clearStoredBidResponses()","abstract":"\u003cp\u003eClears all stored bid responses.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)getStoredBidResponses":{"name":"getStoredBidResponses()","abstract":"\u003cp\u003eRetrieves stored bid responses.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)addCustomHeaderWithName:value:":{"name":"addCustomHeader(name:value:)","abstract":"\u003cp\u003eAdds a custom HTTP header.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(im)clearCustomHeaders":{"name":"clearCustomHeaders()","abstract":"\u003cp\u003eClears all custom HTTP headers.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cm)initializeSDK::":{"name":"initializeSDK(_:_:)","abstract":"\u003cp\u003eInitializes PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cm)initializeSDKWithGadMobileAdsVersion::":{"name":"initializeSDK(gadMobileAdsVersion:_:)","abstract":"\u003cp\u003eInitializes PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/Prebid.html#/c:@M@PrebidMobile@objc(cs)Prebid(cm)initializeSDK:":{"name":"initializeSDK(_:)","abstract":"\u003cp\u003eInitializes PrebidMobile SDK.\u003c/p\u003e","parent_name":"Prebid"},"Classes/VideoInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoInterstitialAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eThe video parameters for this ad unit.","parent_name":"VideoInterstitialAdUnit"},"Classes/VideoInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoInterstitialAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eVideoInterstitialAdUnit\u003c/code\u003e with the specified configuration ID.","parent_name":"VideoInterstitialAdUnit"},"Classes/VideoInterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoInterstitialAdUnit(im)initWithConfigId:minWidthPerc:minHeightPerc:":{"name":"init(configId:minWidthPerc:minHeightPerc:)","abstract":"\u003cp\u003eConvenience initializer to create a video interstitial ad unit with specified minimum width and height percentages.\u003c/p\u003e","parent_name":"VideoInterstitialAdUnit"},"Classes/VideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eThe parameters for video ads associated with this ad unit.\u003c/p\u003e","parent_name":"VideoAdUnit"},"Classes/VideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoAdUnit(im)initWithConfigId:size:":{"name":"init(configId:size:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eVideoAdUnit\u003c/code\u003e with the specified configuration ID and size.\u003c/p\u003e","parent_name":"VideoAdUnit"},"Classes/VideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)VideoAdUnit(im)addAdditionalSizeWithSizes:":{"name":"addAdditionalSize(sizes:)","abstract":"\u003cp\u003eAdds additional sizes to the ad unit.\u003c/p\u003e","parent_name":"VideoAdUnit"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eThe class is created as a singleton object \u0026amp; used\u003c/p\u003e","parent_name":"Utils"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eA delegate to handle native ad events.\u003c/p\u003e","parent_name":"Utils"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(im)convertDictToMoPubKeywordsWithDict:":{"name":"convertDictToMoPubKeywords(dict:)","abstract":"\u003cp\u003eDeprecated. MoPub is not available anymore. Use Prebid MAX adapters instead.\u003c/p\u003e","parent_name":"Utils"},"Classes/Utils.html#/c:@M@PrebidMobile@objc(cs)Utils(im)findNativeWithAdObject:":{"name":"findNative(adObject:)","abstract":"\u003cp\u003eFinds a native ad object within a given object.\u003c/p\u003e","parent_name":"Utils"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eDeprecated property for video parameters.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eProperty for video parameters.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedVideoAdUnit\u003c/code\u003e with the given configuration ID.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/RewardedVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)RewardedVideoAdUnit(im)initWithConfigId:minWidthPerc:minHeightPerc:":{"name":"init(configId:minWidthPerc:minHeightPerc:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eRewardedVideoAdUnit\u003c/code\u003e with the given configuration ID and minimum size percentages.\u003c/p\u003e","parent_name":"RewardedVideoAdUnit"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)api":{"name":"api","abstract":"\u003cp\u003eList of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)maxBitrate":{"name":"maxBitrate","abstract":"\u003cp\u003eMaximum bit rate in Kbps.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)minBitrate":{"name":"minBitrate","abstract":"\u003cp\u003eMaximum bit rate in Kbps.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)maxDuration":{"name":"maxDuration","abstract":"\u003cp\u003eMaximum video ad duration in seconds.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)minDuration":{"name":"minDuration","abstract":"\u003cp\u003eMinimum video ad duration in seconds.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)mimes":{"name":"mimes","abstract":"\u003cp\u003eContent MIME types supported.","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)playbackMethod":{"name":"playbackMethod","abstract":"\u003cp\u003eAllowed playback methods. If none specified, assume all are allowed.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)protocols":{"name":"protocols","abstract":"\u003cp\u003eArray of supported video bid response protocols.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)startDelay":{"name":"startDelay","abstract":"\u003cp\u003eIndicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)placement":{"name":"placement","abstract":"\u003cp\u003ePlacement type for the impression.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)linearity":{"name":"linearity","abstract":"\u003cp\u003eIndicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/s:12PrebidMobile15VideoParametersC6adSizeSo6CGSizeVSgvp":{"name":"adSize","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)rawAPI":{"name":"rawAPI","abstract":"\u003cp\u003eHelper property\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)rawPlaybackMethod":{"name":"rawPlaybackMethod","abstract":"\u003cp\u003eHelper property\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(py)rawProtocols":{"name":"rawProtocols","abstract":"\u003cp\u003eHelper property\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(im)initWithMimes:":{"name":"init(mimes:)","parent_name":"VideoParameters"},"Classes/VideoParameters.html#/c:@M@PrebidMobile@objc(cs)VideoParameters(im)setSize:":{"name":"setSize(_:)","abstract":"\u003cp\u003eObjective-C API\u003c/p\u003e","parent_name":"VideoParameters"},"Classes/SingleContainerInt.html#/s:s27ExpressibleByIntegerLiteralP0cD4TypeQa":{"name":"IntegerLiteralType","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/c:@M@PrebidMobile@objc(cs)SingleContainerInt(py)value":{"name":"value","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/s:s27ExpressibleByIntegerLiteralP07integerD0x0cD4TypeQz_tcfc":{"name":"init(integerLiteral:)","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/c:@M@PrebidMobile@objc(cs)SingleContainerInt(im)isEqual:":{"name":"isEqual(_:)","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"SingleContainerInt"},"Classes/SingleContainerInt.html#/c:@M@PrebidMobile@objc(cs)SingleContainerInt(py)hash":{"name":"hash","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"SingleContainerInt"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC8InStreamAEvpZ":{"name":"InStream","abstract":"\u003cp\u003eIn-Stream\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC8InBannerAEvpZ":{"name":"InBanner","abstract":"\u003cp\u003eIn-Banner\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC9InArticleAEvpZ":{"name":"InArticle","abstract":"\u003cp\u003eIn-Article\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC6InFeedAEvpZ":{"name":"InFeed","abstract":"\u003cp\u003eIn-Feed\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC12InterstitialAEvpZ":{"name":"Interstitial","abstract":"\u003cp\u003eInterstitial\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC6SliderAEvpZ":{"name":"Slider","abstract":"\u003cp\u003eSlider\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC8FloatingAEvpZ":{"name":"Floating","abstract":"\u003cp\u003eFloating\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/Placement.html#/s:12PrebidMobile7SignalsC9PlacementC03getD10ByRawValueyAESgSiFZ":{"name":"getPlacementByRawValue(_:)","abstract":"\u003cp\u003eHelper function\u003c/p\u003e","parent_name":"Placement"},"Classes/Signals/StartDelay.html#/s:12PrebidMobile7SignalsC10StartDelayC7PreRollAEvpZ":{"name":"PreRoll","abstract":"\u003cp\u003ePre-Roll\u003c/p\u003e","parent_name":"StartDelay"},"Classes/Signals/StartDelay.html#/s:12PrebidMobile7SignalsC10StartDelayC14GenericMidRollAEvpZ":{"name":"GenericMidRoll","abstract":"\u003cp\u003eGeneric Mid-Roll\u003c/p\u003e","parent_name":"StartDelay"},"Classes/Signals/StartDelay.html#/s:12PrebidMobile7SignalsC10StartDelayC15GenericPostRollAEvpZ":{"name":"GenericPostRoll","abstract":"\u003cp\u003eGeneric Post-Roll\u003c/p\u003e","parent_name":"StartDelay"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_1_0AEvpZ":{"name":"VAST_1_0","abstract":"\u003cp\u003eVAST 1.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_2_0AEvpZ":{"name":"VAST_2_0","abstract":"\u003cp\u003eVAST 2.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_3_0AEvpZ":{"name":"VAST_3_0","abstract":"\u003cp\u003eVAST 3.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_1_0_WrapperAEvpZ":{"name":"VAST_1_0_Wrapper","abstract":"\u003cp\u003eVAST 1.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_2_0_WrapperAEvpZ":{"name":"VAST_2_0_Wrapper","abstract":"\u003cp\u003eVAST 2.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_3_0_WrapperAEvpZ":{"name":"VAST_3_0_Wrapper","abstract":"\u003cp\u003eVAST 3.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC8VAST_4_0AEvpZ":{"name":"VAST_4_0","abstract":"\u003cp\u003eVAST 4.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC16VAST_4_0_WrapperAEvpZ":{"name":"VAST_4_0_Wrapper","abstract":"\u003cp\u003eVAST 4.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC9DAAST_1_0AEvpZ":{"name":"DAAST_1_0","abstract":"\u003cp\u003eDAAST 1.0\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/Protocols.html#/s:12PrebidMobile7SignalsC9ProtocolsC17DAAST_1_0_WRAPPERAEvpZ":{"name":"DAAST_1_0_WRAPPER","abstract":"\u003cp\u003eDAAST 1.0 Wrapper\u003c/p\u003e","parent_name":"Protocols"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC15AutoPlaySoundOnAEvpZ":{"name":"AutoPlaySoundOn","abstract":"\u003cp\u003eInitiates on Page Load with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC16AutoPlaySoundOffAEvpZ":{"name":"AutoPlaySoundOff","abstract":"\u003cp\u003eInitiates on Page Load with Sound Off by Default\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC11ClickToPlayAEvpZ":{"name":"ClickToPlay","abstract":"\u003cp\u003eInitiates on Click with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC9MouseOverAEvpZ":{"name":"MouseOver","abstract":"\u003cp\u003eInitiates on Mouse-Over with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC12EnterSoundOnAEvpZ":{"name":"EnterSoundOn","abstract":"\u003cp\u003eInitiates on Entering Viewport with Sound On\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/PlaybackMethod.html#/s:12PrebidMobile7SignalsC14PlaybackMethodC13EnterSoundOffAEvpZ":{"name":"EnterSoundOff","abstract":"\u003cp\u003eInitiates on Entering Viewport with Sound Off by Default\u003c/p\u003e","parent_name":"PlaybackMethod"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7VPAID_1AEvpZ":{"name":"VPAID_1","abstract":"\u003cp\u003eVPAID 1.0\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7VPAID_2AEvpZ":{"name":"VPAID_2","abstract":"\u003cp\u003eVPAID 2.0\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7MRAID_1AEvpZ":{"name":"MRAID_1","abstract":"\u003cp\u003eMRAID-1\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC5ORMMAAEvpZ":{"name":"ORMMA","abstract":"\u003cp\u003eORMMA\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7MRAID_2AEvpZ":{"name":"MRAID_2","abstract":"\u003cp\u003eMRAID-2\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC7MRAID_3AEvpZ":{"name":"MRAID_3","abstract":"\u003cp\u003eMRAID-3\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html#/s:12PrebidMobile7SignalsC3ApiC6OMID_1AEvpZ":{"name":"OMID_1","abstract":"\u003cp\u003eOMID-1\u003c/p\u003e","parent_name":"Api"},"Classes/Signals/Api.html":{"name":"Api","abstract":"\u003ch1 id='openrtb-api-frameworks' class='heading'\u003eOpenRTB - API Frameworks\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/PlaybackMethod.html":{"name":"PlaybackMethod","abstract":"\u003ch1 id='openrtb-playback-methods' class='heading'\u003eOpenRTB - Playback Methods\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/Protocols.html":{"name":"Protocols","abstract":"\u003ch1 id='openrtb-protocols' class='heading'\u003eOpenRTB - Protocols\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/StartDelay.html":{"name":"StartDelay","abstract":"\u003ch1 id='openrtb-start-delay' class='heading'\u003eOpenRTB - Start Delay\u003c/h1\u003e","parent_name":"Signals"},"Classes/Signals/Placement.html":{"name":"Placement","abstract":"\u003ch1 id='openrtb-video-placement-types' class='heading'\u003eOpenRTB - Video Placement Types\u003c/h1\u003e","parent_name":"Signals"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)assets":{"name":"assets","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeAsset.html\"\u003eNativeAsset\u003c/a\u003e\u003c/code\u003e objects representing the assets required for the native ad request.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeEventTracker.html\"\u003eNativeEventTracker\u003c/a\u003e\u003c/code\u003e objects specifying the event tracking settings for the native ad.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)version":{"name":"version","abstract":"\u003cp\u003eThe version of the native ad specification being used. Defaults to \u0026ldquo;1.2\u0026rdquo;.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)context":{"name":"context","abstract":"\u003cp\u003eThe context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextType.html\"\u003eContextType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)contextSubType":{"name":"contextSubType","abstract":"\u003cp\u003eA more detailed context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextSubType.html\"\u003eContextSubType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)placementType":{"name":"placementType","abstract":"\u003cp\u003eThe design/format/layout of the ad unit being offered. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/PlacementType.html\"\u003ePlacementType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)placementCount":{"name":"placementCount","abstract":"\u003cp\u003eThe number of identical placements in the ad layout. Defaults to 1.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)sequence":{"name":"sequence","abstract":"\u003cp\u003eThe sequence number of the ad. Defaults to 0.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)asseturlsupport":{"name":"asseturlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning an \u003ccode\u003eassetsurl\u003c/code\u003e instead of an asset object.","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)durlsupport":{"name":"durlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning a \u003ccode\u003edco\u003c/code\u003e URL instead of an asset object.","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)privacy":{"name":"privacy","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning a \u003ccode\u003edco\u003c/code\u003e URL instead of an asset object.","parent_name":"NativeParameters"},"Classes/NativeParameters.html#/c:@M@PrebidMobile@objc(cs)NativeParameters(py)ext":{"name":"ext","abstract":"\u003cp\u003eA placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.\u003c/p\u003e","parent_name":"NativeParameters"},"Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)api":{"name":"api","abstract":"\u003cp\u003eList of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/s:12PrebidMobile16BannerParametersC24interstitialMinWidthPercSiSgvp":{"name":"interstitialMinWidthPerc","abstract":"\u003cp\u003eMin width percentage value for interstitial\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/s:12PrebidMobile16BannerParametersC25interstitialMinHeightPercSiSgvp":{"name":"interstitialMinHeightPerc","abstract":"\u003cp\u003eMin height percentage value for interstitial\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)adSizes":{"name":"adSizes","abstract":"\u003cp\u003eAd sizes of the ad\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)rawAPI":{"name":"rawAPI","abstract":"\u003cp\u003eHelper for \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)api\"\u003eapi\u003c/a\u003e\u003c/code\u003e values\u003c/p\u003e","parent_name":"BannerParameters"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)FeedContent":{"name":"FeedContent","abstract":"\u003cp\u003ePlacement type indicating the ad appears within feed content.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)AtomicContent":{"name":"AtomicContent","abstract":"\u003cp\u003ePlacement type indicating the ad appears within atomic content.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)OutsideContent":{"name":"OutsideContent","abstract":"\u003cp\u003ePlacement type indicating the ad appears outside of content.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)RecommendationWidget":{"name":"RecommendationWidget","abstract":"\u003cp\u003ePlacement type indicating the ad appears within a recommendation widget.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/PlacementType.html#/c:@M@PrebidMobile@objc(cs)PlacementType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003ePlacement type for custom placements not predefined in the standard.\u003c/p\u003e","parent_name":"PlacementType"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(py)text":{"name":"text","abstract":"\u003cp\u003eThe text associated with the text element.\u003c/p\u003e","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/s:12PrebidMobile11NativeTitleC6lengthSiSgvp":{"name":"length","abstract":"\u003cp\u003eThe length of the title being provided.","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeTitle\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeTitle"},"Classes/NativeTitle.html#/c:@M@PrebidMobile@objc(cs)NativeTitle(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeTitle\u003c/code\u003e object with default values.\u003c/p\u003e","parent_name":"NativeTitle"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)version":{"name":"version","abstract":"\u003cp\u003eThe version of the native ad specification being used. Defaults to \u0026ldquo;1.2\u0026rdquo; if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)context":{"name":"context","abstract":"\u003cp\u003eThe context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextType.html\"\u003eContextType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)contextSubType":{"name":"contextSubType","abstract":"\u003cp\u003eA more detailed context in which the ad appears. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ContextSubType.html\"\u003eContextSubType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)placementType":{"name":"placementType","abstract":"\u003cp\u003eThe design/format/layout of the ad unit being offered. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/PlacementType.html\"\u003ePlacementType\u003c/a\u003e\u003c/code\u003e for possible values.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)placementCount":{"name":"placementCount","abstract":"\u003cp\u003eThe number of identical placements in the ad layout. Defaults to 1 if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)sequence":{"name":"sequence","abstract":"\u003cp\u003eThe sequence number of the ad. Defaults to 0 if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)assets":{"name":"assets","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeAsset.html\"\u003eNativeAsset\u003c/a\u003e\u003c/code\u003e objects representing the assets required for the native ad request.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)asseturlsupport":{"name":"asseturlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning an \u003ccode\u003eassetsurl\u003c/code\u003e instead of an asset object.","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)durlsupport":{"name":"durlsupport","abstract":"\u003cp\u003eIndicates whether the supply source/impression supports returning a \u003ccode\u003edco\u003c/code\u003e URL instead of an asset object.","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eAn array of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeEventTracker.html\"\u003eNativeEventTracker\u003c/a\u003e\u003c/code\u003e objects specifying the event tracking settings for the native ad.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)privacy":{"name":"privacy","abstract":"\u003cp\u003eIndicates whether the native ad supports a buyer-specific privacy notice. Defaults to 0 if not set.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)ext":{"name":"ext","abstract":"\u003cp\u003eA placeholder for custom JSON agreed to by the parties to support flexibility beyond the standard specification.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(py)configId":{"name":"configId","abstract":"\u003cp\u003eThe configuration ID for the ad unit.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeRequest\u003c/code\u003e with a specified configuration ID.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)initWithConfigId:assets:eventTrackers:":{"name":"init(configId:assets:eventTrackers:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeRequest\u003c/code\u003e with a specified configuration ID, assets, and event trackers.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)addNativeAssets:":{"name":"addNativeAssets(_:)","abstract":"\u003cp\u003eAdds an array of native assets to the request. If assets already exist, they will be appended.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)addNativeEventTracker:":{"name":"addNativeEventTracker(_:)","abstract":"\u003cp\u003eAdds an array of native event trackers to the request. If event trackers already exist, they will be appended.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeRequest.html#/c:@M@PrebidMobile@objc(cs)NativeRequest(im)getNativeRequestObject":{"name":"getNativeRequestObject()","abstract":"\u003cp\u003eRetrieves the native request object as a JSON dictionary.\u003c/p\u003e","parent_name":"NativeRequest"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)context":{"name":"context","abstract":"\u003cp\u003e[Recommended]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)contextsubtype":{"name":"contextsubtype","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)plcmttype":{"name":"plcmttype","abstract":"\u003cp\u003e[Recommended]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)plcmtcnt":{"name":"plcmtcnt","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)seq":{"name":"seq","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)assets":{"name":"assets","abstract":"\u003cp\u003e[Required]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)aurlsupport":{"name":"aurlsupport","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)durlsupport":{"name":"durlsupport","abstract":"\u003cp\u003e[Integer]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eSpecifies what type of event objects tracking is supported - see Event Trackers Request Object\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)privacy":{"name":"privacy","abstract":"\u003cp\u003e[Recommended]","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(im)copyWithZone:":{"name":"copy(with:)","abstract":"\u003cp\u003eCreates a copy of the current \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(py)jsonDictionary":{"name":"jsonDictionary","abstract":"\u003cp\u003eConverts the \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e instance to a JSON dictionary.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeMarkupRequestObject.html#/c:@M@PrebidMobile@objc(cs)PBMNativeMarkupRequestObject(im)toJsonStringWithError:":{"name":"toJsonString()","abstract":"\u003cp\u003eConverts the \u003ccode\u003eNativeMarkupRequestObject\u003c/code\u003e instance to a JSON string.\u003c/p\u003e","parent_name":"NativeMarkupRequestObject"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)url":{"name":"url","abstract":"\u003cp\u003eLanding URL of the clickable link.\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)clicktrackers":{"name":"clicktrackers","abstract":"\u003cp\u003eList of third-party tracker URLs to be fired on click of the URL.\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)fallback":{"name":"fallback","abstract":"\u003cp\u003eFallback URL for deeplink.","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeLink\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeLink.html#/c:@M@PrebidMobile@objc(cs)NativeLink(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes with default values\u003c/p\u003e","parent_name":"NativeLink"},"Classes/NativeImage.html#/s:12PrebidMobile11NativeImageC4typeSiSgvp":{"name":"type","abstract":"\u003cp\u003eThe type of image element being submitted from the Image Asset Types table.","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(py)url":{"name":"url","abstract":"\u003cp\u003eURL of the image asset.\u003c/p\u003e","parent_name":"NativeImage"},"Classes/NativeImage.html#/s:12PrebidMobile11NativeImageC5widthSiSgvp":{"name":"width","abstract":"\u003cp\u003eWidth of the image in pixels.","parent_name":"NativeImage"},"Classes/NativeImage.html#/s:12PrebidMobile11NativeImageC6heightSiSgvp":{"name":"height","abstract":"\u003cp\u003eHeight of the image in pixels.","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeImage\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeImage"},"Classes/NativeImage.html#/c:@M@PrebidMobile@objc(cs)NativeImage(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes with default values\u003c/p\u003e","parent_name":"NativeImage"},"Classes/NativeEventTrackerResponse.html#/s:12PrebidMobile26NativeEventTrackerResponseC5eventSiSgvp":{"name":"event","abstract":"\u003cp\u003eType of event to track.","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/s:12PrebidMobile26NativeEventTrackerResponseC6methodSiSgvp":{"name":"method","abstract":"\u003cp\u003eType of tracking requested.","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(py)url":{"name":"url","abstract":"\u003cp\u003eThe URL of the image or js.","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(py)customdata":{"name":"customdata","abstract":"\u003cp\u003eTo be agreed individually with the exchange, an array of key:value objects for custom tracking,","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a \u003ccode\u003eNativeEventTrackerResponse\u003c/code\u003e object from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeEventTrackerResponse"},"Classes/NativeEventTrackerResponse.html#/c:@M@PrebidMobile@objc(cs)NativeEventTrackerResponse(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes with default values\u003c/p\u003e","parent_name":"NativeEventTrackerResponse"},"Classes/EventTracking.html#/c:@M@PrebidMobile@objc(cs)EventTracking(cpy)Image":{"name":"Image","abstract":"\u003cp\u003eRepresents image-based event tracking.\u003c/p\u003e","parent_name":"EventTracking"},"Classes/EventTracking.html#/c:@M@PrebidMobile@objc(cs)EventTracking(cpy)js":{"name":"js","abstract":"\u003cp\u003eRepresents JavaScript-based event tracking.\u003c/p\u003e","parent_name":"EventTracking"},"Classes/EventTracking.html#/c:@M@PrebidMobile@objc(cs)EventTracking(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom event tracking method.\u003c/p\u003e","parent_name":"EventTracking"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)Impression":{"name":"Impression","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)ViewableImpression50":{"name":"ViewableImpression50","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)ViewableImpression100":{"name":"ViewableImpression100","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)ViewableVideoImpression50":{"name":"ViewableVideoImpression50","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/EventType.html#/c:@M@PrebidMobile@objc(cs)EventType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"EventType"},"Classes/NativeEventTracker.html#/c:@M@PrebidMobile@objc(cs)NativeEventTracker(im)initWithEvent:methods:":{"name":"init(event:methods:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eNativeEventTracker\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"NativeEventTracker"},"Classes/NativeData.html#/s:12PrebidMobile10NativeDataC4typeSiSgvp":{"name":"type","abstract":"\u003cp\u003eThe type of data element being submitted from the Data Asset Types table.","parent_name":"NativeData"},"Classes/NativeData.html#/s:12PrebidMobile10NativeDataC6lengthSiSgvp":{"name":"length","abstract":"\u003cp\u003eThe length of the data element being submitted.","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(py)value":{"name":"value","abstract":"\u003cp\u003eThe formatted string of data to be displayed.","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eNativeData\u003c/code\u003e object with the provided JSON dictionary.\u003c/p\u003e","parent_name":"NativeData"},"Classes/NativeData.html#/c:@M@PrebidMobile@objc(cs)NativeData(im)init":{"name":"init()","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e","parent_name":"NativeData"},"Classes/ImageAsset.html#/c:@M@PrebidMobile@objc(cs)ImageAsset(cpy)Icon":{"name":"Icon","abstract":"\u003cp\u003eRepresents an icon image asset.\u003c/p\u003e","parent_name":"ImageAsset"},"Classes/ImageAsset.html#/c:@M@PrebidMobile@objc(cs)ImageAsset(cpy)Main":{"name":"Main","abstract":"\u003cp\u003eRepresents the main image asset.\u003c/p\u003e","parent_name":"ImageAsset"},"Classes/ImageAsset.html#/c:@M@PrebidMobile@objc(cs)ImageAsset(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom image asset.\u003c/p\u003e","parent_name":"ImageAsset"},"Classes/NativeAssetData.html#/s:12PrebidMobile15NativeAssetDataC6lengthSiSgvp":{"name":"length","abstract":"\u003cp\u003eThe length of the data asset.\u003c/p\u003e","parent_name":"NativeAssetData"},"Classes/NativeAssetData.html#/c:@M@PrebidMobile@objc(cs)NativeAssetData(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional custom properties for the data asset.\u003c/p\u003e","parent_name":"NativeAssetData"},"Classes/NativeAssetData.html#/c:@M@PrebidMobile@objc(cs)NativeAssetData(im)initWithType:required:":{"name":"init(type:required:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetData\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetData"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(py)type":{"name":"type","abstract":"\u003cp\u003eThe type of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC5widthSiSgvp":{"name":"width","abstract":"\u003cp\u003eThe width of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC8widthMinSiSgvp":{"name":"widthMin","abstract":"\u003cp\u003eThe minimum width of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC6heightSiSgvp":{"name":"height","abstract":"\u003cp\u003eThe height of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/s:12PrebidMobile16NativeAssetImageC9heightMinSiSgvp":{"name":"heightMin","abstract":"\u003cp\u003eThe minimum height of the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(py)mimes":{"name":"mimes","abstract":"\u003cp\u003eThe MIME types supported for the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional custom properties for the image asset.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(im)initWithMinimumWidth:minimumHeight:required:":{"name":"init(minimumWidth:minimumHeight:required:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetImage\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetImage.html#/c:@M@PrebidMobile@objc(cs)NativeAssetImage(im)initWithIsRequired:":{"name":"init(isRequired:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetImage\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetImage"},"Classes/NativeAssetTitle.html#/c:@M@PrebidMobile@objc(cs)NativeAssetTitle(py)ext":{"name":"ext","abstract":"\u003cp\u003eAdditional custom properties for the title asset.\u003c/p\u003e","parent_name":"NativeAssetTitle"},"Classes/NativeAssetTitle.html#/c:@M@PrebidMobile@objc(cs)NativeAssetTitle(im)initWithLength:required:":{"name":"init(length:required:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAssetTitle\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAssetTitle"},"Classes/NativeAsset.html#/s:12PrebidMobile11NativeAssetC8requiredSbvp":{"name":"required","abstract":"\u003cp\u003eIndicates whether the asset is required for the ad to be considered valid.\u003c/p\u003e","parent_name":"NativeAsset"},"Classes/NativeAsset.html#/s:12PrebidMobile11NativeAssetC10isRequiredACSb_tcfc":{"name":"init(isRequired:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAsset\u003c/code\u003e.\u003c/p\u003e","parent_name":"NativeAsset"},"Classes/NativeAdMarkupAsset.html#/s:12PrebidMobile19NativeAdMarkupAssetC2idSiSgvp":{"name":"id","abstract":"\u003cp\u003eOptional if asseturl/dcourl is being used; required if embeded asset is being used\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/s:12PrebidMobile19NativeAdMarkupAssetC8requiredSiSgvp":{"name":"required","abstract":"\u003cp\u003eSet to 1 if asset is required. (bidder requires it to be displayed).\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)title":{"name":"title","abstract":"\u003cp\u003eTitle object for title assets.","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)img":{"name":"img","abstract":"\u003cp\u003eImage object for image assets.","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)data":{"name":"data","abstract":"\u003cp\u003eData object for ratings, prices etc.\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)link":{"name":"link","abstract":"\u003cp\u003eLink object for call to actions.","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkupAsset\u003c/code\u003e from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkupAsset.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkupAsset(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkupAsset\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeAdMarkupAsset"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)version":{"name":"version","abstract":"\u003cp\u003eVersion of the Native Markup version in use.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)assets":{"name":"assets","abstract":"\u003cp\u003eList of native ad’s assets.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)assetsurl":{"name":"assetsurl","abstract":"\u003cp\u003eURL of an alternate source for the assets object.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)dcourl":{"name":"dcourl","abstract":"\u003cp\u003eURL where a dynamic creative specification may be found for populating this ad, per the Dynamic Content Ads Specification.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)link":{"name":"link","abstract":"\u003cp\u003eDestination Link.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)imptrackers":{"name":"imptrackers","abstract":"\u003cp\u003eArray of impression tracking URLs, expected to return a 1x1 image or 204 response - typically only passed when using 3rd party trackers.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)jstracker":{"name":"jstracker","abstract":"\u003cp\u003eOptional JavaScript impression tracker.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)eventtrackers":{"name":"eventtrackers","abstract":"\u003cp\u003eArray of tracking objects to run with the ad, in response to the declared supported methods in the request.","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)privacy":{"name":"privacy","abstract":"\u003cp\u003eIf support was indicated in the request, URL of a page informing the user about the buyer’s targeting activity.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(py)ext":{"name":"ext","abstract":"\u003cp\u003eThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(im)initWithJsonString:":{"name":"init(jsonString:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkup\u003c/code\u003e from a JSON string.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(im)initWithJsonDictionary:":{"name":"init(jsonDictionary:)","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkup\u003c/code\u003e from a JSON dictionary.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdMarkup.html#/c:@M@PrebidMobile@objc(cs)NativeAdMarkup(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003eNativeAdMarkup\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeAdMarkup"},"Classes/NativeAdConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMNativeAdConfiguration(py)version":{"name":"version","abstract":"\u003cp\u003eVersion of the Native Markup version in use.\u003c/p\u003e","parent_name":"NativeAdConfiguration"},"Classes/NativeAdConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMNativeAdConfiguration(py)markupRequestObject":{"name":"markupRequestObject","abstract":"\u003cp\u003eThe object containing the request details for the native markup.\u003c/p\u003e","parent_name":"NativeAdConfiguration"},"Classes/NativeAdConfiguration.html#/c:@M@PrebidMobile@objc(cs)PBMNativeAdConfiguration(im)init":{"name":"init()","abstract":"\u003cp\u003eInitializes a new instance of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/NativeAdMarkup.html\"\u003eNativeAdMarkup\u003c/a\u003e\u003c/code\u003e with default values.\u003c/p\u003e","parent_name":"NativeAdConfiguration"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)nativeAdMarkup":{"name":"nativeAdMarkup","abstract":"\u003cp\u003eThe native ad markup containing the ad assets.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)delegate":{"name":"delegate","abstract":"\u003cp\u003eThe delegate to receive native ad events.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)titles":{"name":"titles","abstract":"\u003cp\u003eReturns an array of titles from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)dataObjects":{"name":"dataObjects","abstract":"\u003cp\u003eReturns an array of data objects from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)images":{"name":"images","abstract":"\u003cp\u003eReturns an array of images from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)eventTrackers":{"name":"eventTrackers","abstract":"\u003cp\u003eReturns an array of event trackers from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(im)dataObjectsOf:":{"name":"dataObjects(of:)","abstract":"\u003cp\u003eReturns an array of data objects filtered by the specified data type.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(im)imagesOf:":{"name":"images(of:)","abstract":"\u003cp\u003eReturns an array of images filtered by the specified image type.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)title":{"name":"title","abstract":"\u003cp\u003eReturns the first title text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)imageUrl":{"name":"imageUrl","abstract":"\u003cp\u003eReturns the URL of the main image from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)iconUrl":{"name":"iconUrl","abstract":"\u003cp\u003eReturns the URL of the icon image from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)sponsoredBy":{"name":"sponsoredBy","abstract":"\u003cp\u003eReturns the sponsored by text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)text":{"name":"text","abstract":"\u003cp\u003eReturns the description text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(py)callToAction":{"name":"callToAction","abstract":"\u003cp\u003eReturns the call-to-action text from the native ad markup.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(cm)createWithCacheId:":{"name":"create(cacheId:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003eNativeAd\u003c/code\u003e instance from the given cache ID.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/NativeAd.html#/c:@M@PrebidMobile@objc(cs)NativeAd(im)registerViewWithView:clickableViews:":{"name":"registerView(view:clickableViews:)","abstract":"\u003cp\u003eRegisters a view for tracking viewability and click events.\u003c/p\u003e","parent_name":"NativeAd"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Content":{"name":"Content","abstract":"\u003cp\u003eRepresents a content context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Social":{"name":"Social","abstract":"\u003cp\u003eRepresents a social media context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Product":{"name":"Product","abstract":"\u003cp\u003eRepresents a product context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextType.html#/c:@M@PrebidMobile@objc(cs)ContextType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom context type.\u003c/p\u003e","parent_name":"ContextType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)General":{"name":"General","abstract":"\u003cp\u003eRepresents a general context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Article":{"name":"Article","abstract":"\u003cp\u003eRepresents an article context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Video":{"name":"Video","abstract":"\u003cp\u003eRepresents a video context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Audio":{"name":"Audio","abstract":"\u003cp\u003eRepresents an audio context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Image":{"name":"Image","abstract":"\u003cp\u003eRepresents an image context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)UserGenerated":{"name":"UserGenerated","abstract":"\u003cp\u003eRepresents a user-generated content context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Social":{"name":"Social","abstract":"\u003cp\u003eRepresents a social media context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)email":{"name":"email","abstract":"\u003cp\u003eRepresents an email context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)chatIM":{"name":"chatIM","abstract":"\u003cp\u003eRepresents a chat or instant messaging context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)SellingProduct":{"name":"SellingProduct","abstract":"\u003cp\u003eRepresents a product selling context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)AppStore":{"name":"AppStore","abstract":"\u003cp\u003eRepresents an App Store context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)ReviewSite":{"name":"ReviewSite","abstract":"\u003cp\u003eRepresents a review site context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/ContextSubType.html#/c:@M@PrebidMobile@objc(cs)ContextSubType(cpy)Custom":{"name":"Custom","abstract":"\u003cp\u003eRepresents a custom context type.\u003c/p\u003e","parent_name":"ContextSubType"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)initWithBannerParameters:videoParameters:nativeParameters:isInterstitial:isRewarded:":{"name":"init(bannerParameters:videoParameters:nativeParameters:isInterstitial:isRewarded:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003ePrebidRequest\u003c/code\u003e with the given parameters.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)setGPID:":{"name":"setGPID(_:)","abstract":"\u003cp\u003eSets the GPID for the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content for the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the app content for the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds data to the app content.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves specific data from the app content.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all data from the app content.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds user data to the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves specific user data from the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidRequest.html#/c:@M@PrebidMobile@objc(cs)PrebidRequest(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data from the ad request.\u003c/p\u003e","parent_name":"PrebidRequest"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(py)pbAdSlot":{"name":"pbAdSlot","abstract":"\u003cp\u003eThe ad slot identifier for the Prebid ad unit.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003ePrebidAdUnit\u003c/code\u003e with the given configuration ID.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)fetchDemandWithAdObject:request:completion:":{"name":"fetchDemand(adObject:request:completion:)","abstract":"\u003cp\u003eMakes bid request for the specified ad object and request config. Setups targeting keywords into the adObject.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)fetchDemandWithRequest:completion:":{"name":"fetchDemand(request:completion:)","abstract":"\u003cp\u003eMakes bid request for the specified request config.\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)setAutoRefreshMillisWithTime:":{"name":"setAutoRefreshMillis(time:)","abstract":"\u003cp\u003eThis method allows to set the auto refresh period for the demand\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)stopAutoRefresh":{"name":"stopAutoRefresh()","abstract":"\u003cp\u003eThis method stops the auto refresh of demand\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/PrebidAdUnit.html#/c:@M@PrebidMobile@objc(cs)PrebidAdUnit(im)resumeAutoRefresh":{"name":"resumeAutoRefresh()","abstract":"\u003cp\u003eThis method resumes the auto refresh of demand\u003c/p\u003e","parent_name":"PrebidAdUnit"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(cpy)EVENT_WIN":{"name":"EVENT_WIN","abstract":"\u003cp\u003eKey to get Prebid win event from \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)events\"\u003eevents\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(cpy)EVENT_IMP":{"name":"EVENT_IMP","abstract":"\u003cp\u003eKey to get Prebid imp event from \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)events\"\u003eevents\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)resultCode":{"name":"resultCode","abstract":"\u003cp\u003eThe result code of the bid request\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)targetingKeywords":{"name":"targetingKeywords","abstract":"\u003cp\u003eTargeting keywords associated with the bid\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/s:12PrebidMobile7BidInfoC3expSdSgvp":{"name":"exp","abstract":"\u003cp\u003eThe expiration time of the bid\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)nativeAdCacheId":{"name":"nativeAdCacheId","abstract":"\u003cp\u003eThe cache ID for native ads\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(py)events":{"name":"events","abstract":"\u003cp\u003eEvents related to the bid\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/s:12PrebidMobile7BidInfoC10resultCode17targetingKeywords3exp15nativeAdCacheId6eventsAcA06ResultF0O_SDyS2SGSgSdSgSSSgAKtcfc":{"name":"init(resultCode:targetingKeywords:exp:nativeAdCacheId:events:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBidInfo\u003c/code\u003e instance with the specified parameters.\u003c/p\u003e","parent_name":"BidInfo"},"Classes/BidInfo.html#/c:@M@PrebidMobile@objc(cs)PBMBidInfo(im)getExp":{"name":"getExp()","abstract":"\u003cp\u003eRetrieves the expiration time of the bid as an \u003ccode\u003eNSNumber\u003c/code\u003e.\u003c/p\u003e","parent_name":"BidInfo"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eThe deprecated banner parameters for this ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eThe banner parameters for this ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video parameters for this ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe ad formats for the ad unit.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(im)initWithConfigId:":{"name":"init(configId:)","abstract":"\u003cp\u003eInitializes a new interstitial ad unit with a unique configuration identifier.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InterstitialAdUnit.html#/c:@M@PrebidMobile@objc(cs)InterstitialAdUnit(im)initWithConfigId:minWidthPerc:minHeightPerc:":{"name":"init(configId:minWidthPerc:minHeightPerc:)","abstract":"\u003cp\u003eInitializes a new interstitial ad unit with a minimum width and height percentage.\u003c/p\u003e","parent_name":"InterstitialAdUnit"},"Classes/InstreamVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)InstreamVideoAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video parameters for this ad unit.\u003c/p\u003e","parent_name":"InstreamVideoAdUnit"},"Classes/InstreamVideoAdUnit.html#/c:@M@PrebidMobile@objc(cs)InstreamVideoAdUnit(im)initWithConfigId:size:":{"name":"init(configId:size:)","abstract":"\u003cp\u003eInitializes a new instream video ad unit.\u003c/p\u003e","parent_name":"InstreamVideoAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)parameters":{"name":"parameters","abstract":"\u003cp\u003eA deprecated property for banner ad parameters.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)bannerParameters":{"name":"bannerParameters","abstract":"\u003cp\u003eThe banner ad parameters used to configure the ad unit.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)videoParameters":{"name":"videoParameters","abstract":"\u003cp\u003eThe video ad parameters used to configure the ad unit.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(py)adFormats":{"name":"adFormats","abstract":"\u003cp\u003eThe set of ad formats for the ad unit.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(im)initWithConfigId:size:":{"name":"init(configId:size:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eBannerAdUnit\u003c/code\u003e with the specified configuration ID and size.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/BannerAdUnit.html#/c:@M@PrebidMobile@objc(cs)BannerAdUnit(im)addAdditionalSizeWithSizes:":{"name":"addAdditionalSize(sizes:)","abstract":"\u003cp\u003eAdds additional sizes to the banner ad unit\u0026rsquo;s configuration.\u003c/p\u003e","parent_name":"BannerAdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(py)pbAdSlot":{"name":"pbAdSlot","abstract":"\u003cp\u003eORTB: imp[].ext.data.adslot\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/s:12PrebidMobile6AdUnitC8configId4size9adFormatsACSS_So6CGSizeVSgShyAA0C6FormatCGtcfc":{"name":"init(configId:size:adFormats:)","abstract":"\u003cp\u003eInitializes a new \u003ccode\u003eAdUnit\u003c/code\u003e instance with the specified configuration ID, size, and ad formats.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)fetchDemandWithCompletion:":{"name":"fetchDemand(completion:)","abstract":"\u003cp\u003eMakes bid request and provides the result as a dictionary of key-value pairs.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)fetchDemandWithCompletionBidInfo:":{"name":"fetchDemand(completionBidInfo:)","abstract":"\u003cp\u003eMakes bid request and provides the result as a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/BidInfo.html\"\u003eBidInfo\u003c/a\u003e\u003c/code\u003e object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)fetchDemandWithAdObject:completion:":{"name":"fetchDemand(adObject:completion:)","abstract":"\u003cp\u003eMakes bid request for a specific ad object and provides the result code. Setups targeting keywords into the adObject.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addContextDataWithKey:value:":{"name":"addContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; value for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)updateContextDataWithKey:value:":{"name":"updateContextData(key:value:)","abstract":"\u003cp\u003eThis method obtains the context data keyword \u0026amp; values for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeContextDataForKey:":{"name":"removeContextData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific context data keyword \u0026amp; values set from adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearContextData":{"name":"clearContextData()","abstract":"\u003cp\u003eThis method allows to remove all context data set from adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addExtDataWithKey:value:":{"name":"addExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; value for adunit targeting.","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)updateExtDataWithKey:value:":{"name":"updateExtData(key:value:)","abstract":"\u003cp\u003eThis method obtains the ext data keyword \u0026amp; values for adunit targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeExtDataForKey:":{"name":"removeExtData(forKey:)","abstract":"\u003cp\u003eThis method allows to remove specific ext data keyword \u0026amp; values set from adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearExtData":{"name":"clearExtData()","abstract":"\u003cp\u003eThis method allows to remove all ext data set from adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addContextKeyword:":{"name":"addContextKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addContextKeywords:":{"name":"addContextKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the context keyword set for adunit context targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeContextKeyword:":{"name":"removeContextKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific context keyword from adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearContextKeywords":{"name":"clearContextKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit context targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addExtKeyword:":{"name":"addExtKeyword(_:)","abstract":"\u003cp\u003eThis method obtains the keyword for adunit targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addExtKeywords:":{"name":"addExtKeywords(_:)","abstract":"\u003cp\u003eThis method obtains the keyword set for adunit targeting","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeExtKeyword:":{"name":"removeExtKeyword(_:)","abstract":"\u003cp\u003eThis method allows to remove specific keyword from adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearExtKeywords":{"name":"clearExtKeywords()","abstract":"\u003cp\u003eThis method allows to remove all keywords from the set of adunit targeting\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setAppContent:":{"name":"setAppContent(_:)","abstract":"\u003cp\u003eSets the app content object, replacing any existing content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getAppContent":{"name":"getAppContent()","abstract":"\u003cp\u003eRetrieves the current app content object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearAppContent":{"name":"clearAppContent()","abstract":"\u003cp\u003eClears the current app content object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addAppContentData:":{"name":"addAppContentData(_:)","abstract":"\u003cp\u003eAdds an array of content data objects to the app content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeAppContentData:":{"name":"removeAppContentData(_:)","abstract":"\u003cp\u003eRemoves a specific content data object from the app content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearAppContentData":{"name":"clearAppContentData()","abstract":"\u003cp\u003eClears all content data objects from the app content.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getUserData":{"name":"getUserData()","abstract":"\u003cp\u003eRetrieves the current user data.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)addUserData:":{"name":"addUserData(_:)","abstract":"\u003cp\u003eAdds an array of user data objects.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)removeUserData:":{"name":"removeUserData(_:)","abstract":"\u003cp\u003eRemoves a specific user data object.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)clearUserData":{"name":"clearUserData()","abstract":"\u003cp\u003eClears all user data.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setGPID:":{"name":"setGPID(_:)","abstract":"\u003cp\u003eSets the GPID for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getGPID":{"name":"getGPID()","abstract":"\u003cp\u003eRetrieves the current GPID for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setOrtbConfig:":{"name":"setOrtbConfig(_:)","abstract":"\u003cp\u003eSets the OpenRTB configuration string for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)getOrtbConfig":{"name":"getOrtbConfig()","abstract":"\u003cp\u003eRetrieves the current OpenRTB configuration string for the ad unit.\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)setAutoRefreshMillisWithTime:":{"name":"setAutoRefreshMillis(time:)","abstract":"\u003cp\u003eThis method allows to set the auto refresh period for the demand\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)stopAutoRefresh":{"name":"stopAutoRefresh()","abstract":"\u003cp\u003eThis method stops the auto refresh of demand\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html#/c:@M@PrebidMobile@objc(cs)AdUnit(im)resumeAutoRefresh":{"name":"resumeAutoRefresh()","abstract":"\u003cp\u003eThis method resumes the auto refresh of demand\u003c/p\u003e","parent_name":"AdUnit"},"Classes/AdUnit.html":{"name":"AdUnit","abstract":"\u003cp\u003eBase class for ad units built for original type of integration.\u003c/p\u003e"},"Classes/BannerAdUnit.html":{"name":"BannerAdUnit","abstract":"\u003cp\u003eA class representing a banner ad unit for original type of integration.\u003c/p\u003e"},"Classes/InstreamVideoAdUnit.html":{"name":"InstreamVideoAdUnit","abstract":"\u003cp\u003eRepresents an instream video ad unit for original type of integration.\u003c/p\u003e"},"Classes/InterstitialAdUnit.html":{"name":"InterstitialAdUnit","abstract":"\u003cp\u003eRepresents an interstitial ad unit built for original type of integration.\u003c/p\u003e"},"Classes/BidInfo.html":{"name":"BidInfo","abstract":"\u003cp\u003eContains information about bid.\u003c/p\u003e"},"Classes/PrebidAdUnit.html":{"name":"PrebidAdUnit","abstract":"\u003cp\u003eMultiformat ad unit. Built for original API.\u003c/p\u003e"},"Classes/PrebidRequest.html":{"name":"PrebidRequest","abstract":"\u003cp\u003eClass that contains properties and methods to configure Prebid request.\u003c/p\u003e"},"Classes/ContextSubType.html":{"name":"ContextSubType","abstract":"\u003cp\u003eNative context subtype asset.\u003c/p\u003e"},"Classes/ContextType.html":{"name":"ContextType","abstract":"\u003cp\u003eNative context type asset.\u003c/p\u003e"},"Classes/NativeAd.html":{"name":"NativeAd","abstract":"\u003cp\u003eRepresents a native ad and handles its various properties and functionalities.\u003c/p\u003e"},"Classes/NativeAdConfiguration.html":{"name":"NativeAdConfiguration","abstract":"\u003cp\u003eRepresents the configuration for a native ad, including markup and version information.\u003c/p\u003e"},"Classes/NativeAdMarkup.html":{"name":"NativeAdMarkup","abstract":"\u003cp\u003eRepresents the markup for a native ad, including assets, tracking URLs, and other metadata.\u003c/p\u003e"},"Classes/NativeAdMarkupAsset.html":{"name":"NativeAdMarkupAsset","abstract":"\u003cp\u003eRepresents an asset in the native ad markup, which can be a title, image, data, or link.\u003c/p\u003e"},"Classes/NativeAsset.html":{"name":"NativeAsset","abstract":"\u003cp\u003eRepresents a generic native ad asset which could be a title, image, or data.\u003c/p\u003e"},"Classes/NativeAssetTitle.html":{"name":"NativeAssetTitle","abstract":"\u003cp\u003eRepresents a title asset in a native ad.\u003c/p\u003e"},"Classes/NativeAssetImage.html":{"name":"NativeAssetImage","abstract":"\u003cp\u003eRepresents an image asset in a native ad.\u003c/p\u003e"},"Classes/NativeAssetData.html":{"name":"NativeAssetData","abstract":"\u003cp\u003eRepresents a data asset in a native ad.\u003c/p\u003e"},"Classes/ImageAsset.html":{"name":"ImageAsset","abstract":"\u003cp\u003eNative image asset type.\u003c/p\u003e"},"Classes/NativeData.html":{"name":"NativeData","abstract":"\u003cp\u003eClass representing native data elements in the ad markup.\u003c/p\u003e"},"Classes/NativeEventTracker.html":{"name":"NativeEventTracker","abstract":"\u003cp\u003eClass representing an event tracker for native ads.\u003c/p\u003e"},"Classes/EventType.html":{"name":"EventType","abstract":"\u003cp\u003eClass representing different event types.\u003c/p\u003e"},"Classes/EventTracking.html":{"name":"EventTracking","abstract":"\u003cp\u003eNative event tracking type.\u003c/p\u003e"},"Classes/NativeEventTrackerResponse.html":{"name":"NativeEventTrackerResponse","abstract":"\u003cp\u003eClass representing a response for a native event tracker.\u003c/p\u003e"},"Classes/NativeImage.html":{"name":"NativeImage","abstract":"\u003cp\u003eClass representing an image asset in a native ad.\u003c/p\u003e"},"Classes/NativeLink.html":{"name":"NativeLink","abstract":"\u003cp\u003eClass representing a link in a native ad.\u003c/p\u003e"},"Classes/NativeMarkupRequestObject.html":{"name":"NativeMarkupRequestObject","abstract":"\u003cp\u003eRepresents a request object for native markup, including details about the ad\u0026rsquo;s context, placement, and supported features.\u003c/p\u003e"},"Classes/NativeRequest.html":{"name":"NativeRequest","abstract":"\u003cp\u003eA class representing a native request for original type of integration.\u003c/p\u003e"},"Classes/NativeTitle.html":{"name":"NativeTitle","abstract":"\u003cp\u003eRepresents the title element in a native ad, including optional text and length.\u003c/p\u003e"},"Classes/PlacementType.html":{"name":"PlacementType","abstract":"\u003cp\u003eRepresents different types of placements for native ads.\u003c/p\u003e"},"Classes/BannerParameters.html":{"name":"BannerParameters","abstract":"\u003cp\u003eDescribes an \u003ca href=\"https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf\"\u003eOpenRTB\u003c/a\u003e banner object\u003c/p\u003e"},"Classes/NativeParameters.html":{"name":"NativeParameters","abstract":"\u003cp\u003eRepresents parameters for a native ad request, including assets, event trackers, and configuration settings.\u003c/p\u003e"},"Classes/Signals.html":{"name":"Signals","abstract":"\u003cp\u003eA class containing constants related to OpenRTB signals.\u003c/p\u003e"},"Classes/SingleContainerInt.html":{"name":"SingleContainerInt","abstract":"\u003cp\u003eUndocumented\u003c/p\u003e"},"Classes/VideoParameters.html":{"name":"VideoParameters","abstract":"\u003cp\u003eDescribes an \u003ca href=\"https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf\"\u003eOpenRTB\u003c/a\u003e video object\u003c/p\u003e"},"Classes/RewardedVideoAdUnit.html":{"name":"RewardedVideoAdUnit","abstract":"\u003cp\u003eRepresents an rewarded ad unit for original type of integration.\u003c/p\u003e"},"Classes/Utils.html":{"name":"Utils","abstract":"\u003cp\u003eA utility class for handling various ad-related operations and conversions.\u003c/p\u003e"},"Classes/VideoAdUnit.html":{"name":"VideoAdUnit","abstract":"\u003cp\u003eA deprecated class for handling video ad units.\u003c/p\u003e"},"Classes/VideoInterstitialAdUnit.html":{"name":"VideoInterstitialAdUnit","abstract":"\u003cp\u003eA deprecated class representing a video interstitial ad unit."},"Classes/Prebid.html":{"name":"Prebid","abstract":"\u003cp\u003eThe \u003ccode\u003ePrebid\u003c/code\u003e class manages the configuration and initialization of the PrebidMobile SDK.\u003c/p\u003e"},"Classes/Targeting.html":{"name":"Targeting","abstract":"\u003cp\u003eA class that manages targeting information for ads.\u003c/p\u003e"},"Classes/ExternalUserId.html":{"name":"ExternalUserId","abstract":"\u003cp\u003eDefines the User Id Object from an External Thrid Party Source\u003c/p\u003e"},"Classes/Host.html":{"name":"Host","abstract":"\u003cp\u003eA singleton class that manages the Prebid server URL, including a custom URL.\u003c/p\u003e"},"Classes/AdFormat.html":{"name":"AdFormat","abstract":"\u003cp\u003e\u003ccode\u003eAdFormat\u003c/code\u003e is a class that represents different types of ad formats using an OptionSet."},"Classes/VideoControlsConfiguration.html":{"name":"VideoControlsConfiguration","abstract":"\u003cp\u003eA class representing the configuration for video controls in an ad."},"Classes/BannerView.html":{"name":"BannerView","abstract":"\u003cp\u003eThe view that will display the particular banner ad. Built for rendering type of integration.\u003c/p\u003e"},"Classes/BaseInterstitialAdUnit.html":{"name":"BaseInterstitialAdUnit","abstract":"\u003cp\u003eA base class for interstitial ad units.\u003c/p\u003e"},"Classes/InterstitialRenderingAdUnit.html":{"name":"InterstitialRenderingAdUnit","abstract":"\u003cp\u003eRepresents an interstitial ad unit. Built for rendering type of integration.\u003c/p\u003e"},"Classes/RewardedAdUnit.html":{"name":"RewardedAdUnit","abstract":"\u003cp\u003eRepresents an rewarded ad unit. Built for rendering type of integration.\u003c/p\u003e"},"Classes/MediationBannerAdUnit.html":{"name":"MediationBannerAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes/MediationBaseInterstitialAdUnit.html":{"name":"MediationBaseInterstitialAdUnit","abstract":"\u003cp\u003eBase class for interstitial ads in Mediation API.\u003c/p\u003e"},"Classes/MediationInterstitialAdUnit.html":{"name":"MediationInterstitialAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes/MediationNativeAdUnit.html":{"name":"MediationNativeAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes/MediationRewardedAdUnit.html":{"name":"MediationRewardedAdUnit","abstract":"\u003cp\u003eThis class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs."},"Classes.html":{"name":"Classes","abstract":"\u003cp\u003eThe following classes are available globally.\u003c/p\u003e"},"Enums.html":{"name":"Enumerations","abstract":"\u003cp\u003eThe following enumerations are available globally.\u003c/p\u003e"},"Protocols.html":{"name":"Protocols","abstract":"\u003cp\u003eThe following protocols are available globally.\u003c/p\u003e"},"Typealiases.html":{"name":"Type Aliases","abstract":"\u003cp\u003eThe following type aliases are available globally.\u003c/p\u003e"}} \ No newline at end of file diff --git a/docs/undocumented.json b/docs/undocumented.json new file mode 100644 index 000000000..c677a75d3 --- /dev/null +++ b/docs/undocumented.json @@ -0,0 +1,369 @@ +{ + "warnings": [ + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAdDelegate.swift", + "line": 18, + "symbol": "NativeAdDelegate", + "symbol_kind": "source.lang.swift.decl.protocol", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 201, + "symbol": "DataAsset.sponsored", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 202, + "symbol": "DataAsset.description", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 203, + "symbol": "DataAsset.rating", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 204, + "symbol": "DataAsset.likes", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 205, + "symbol": "DataAsset.downloads", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 206, + "symbol": "DataAsset.price", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 207, + "symbol": "DataAsset.saleprice", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 208, + "symbol": "DataAsset.phone", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 209, + "symbol": "DataAsset.address", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 210, + "symbol": "DataAsset.description2", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 211, + "symbol": "DataAsset.displayurl", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeAsset.swift", + "line": 212, + "symbol": "DataAsset.ctatext", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeData.swift", + "line": 57, + "symbol": "NativeData.init()", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeDataAssetType.swift", + "line": 23, + "symbol": "NativeDataAssetType.undefined", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeEventTracker.swift", + "line": 61, + "symbol": "EventType.Impression", + "symbol_kind": "source.lang.swift.decl.var.static", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeEventTracker.swift", + "line": 64, + "symbol": "EventType.ViewableImpression50", + "symbol_kind": "source.lang.swift.decl.var.static", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeEventTracker.swift", + "line": 67, + "symbol": "EventType.ViewableImpression100", + "symbol_kind": "source.lang.swift.decl.var.static", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeEventTracker.swift", + "line": 70, + "symbol": "EventType.ViewableVideoImpression50", + "symbol_kind": "source.lang.swift.decl.var.static", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Native/NativeEventTracker.swift", + "line": 73, + "symbol": "EventType.Custom", + "symbol_kind": "source.lang.swift.decl.var.static", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Parameters/SingleContainerInt.swift", + "line": 18, + "symbol": "SingleContainerInt", + "symbol_kind": "source.lang.swift.decl.class", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Parameters/SingleContainerInt.swift", + "line": 23, + "symbol": "SingleContainerInt.value", + "symbol_kind": "source.lang.swift.decl.var.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Parameters/SingleContainerInt.swift", + "line": 34, + "symbol": "SingleContainerInt.isEqual(_:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Parameters/SingleContainerInt.swift", + "line": 48, + "symbol": "SingleContainerInt.hash", + "symbol_kind": "source.lang.swift.decl.var.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/AdUnits/Parameters/VideoParameters.swift", + "line": 62, + "symbol": "VideoParameters.adSize", + "symbol_kind": "source.lang.swift.decl.var.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/ConfigurationAndTargeting/Targeting.swift", + "line": 239, + "symbol": "Targeting.getExternalUserIds()", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 23, + "symbol": "Position.undefined", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 24, + "symbol": "Position.topLeft", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 25, + "symbol": "Position.topCenter", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 26, + "symbol": "Position.topRight", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 27, + "symbol": "Position.center", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 28, + "symbol": "Position.bottomLeft", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 29, + "symbol": "Position.bottomCenter", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 30, + "symbol": "Position.bottomRight", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/AdTypes/AdView/Position.swift", + "line": 31, + "symbol": "Position.custom", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerEventHandler.swift", + "line": 34, + "symbol": "BannerEventHandler.trackImpression()", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 79, + "symbol": "BannerView.ortbConfig", + "symbol_kind": "source.lang.swift.decl.var.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 404, + "symbol": "BannerView.trackImpression(forDisplayView:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 413, + "symbol": "BannerView.viewControllerForModalPresentation(fromDisplayView:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 417, + "symbol": "BannerView.didLeaveApp(from:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 421, + "symbol": "BannerView.willPresentModal(from:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 425, + "symbol": "BannerView.didDismissModal(from:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 431, + "symbol": "BannerView.bannerAdLoader(_:loadedAdView:adSize:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 436, + "symbol": "BannerView.bannerAdLoader(_:createdDisplayView:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 442, + "symbol": "BannerView.adLoadFlowController(_:failedWithError:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 446, + "symbol": "BannerView.adLoadFlowControllerWillSendBidRequest(_:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 451, + "symbol": "BannerView.adLoadFlowControllerWillRequestPrimaryAd(_:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 456, + "symbol": "BannerView.adLoadFlowControllerShouldContinue(_:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 462, + "symbol": "BannerView.willPresentModal()", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 469, + "symbol": "BannerView.didDismissModal()", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 476, + "symbol": "BannerView.willLeaveApp()", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + }, + { + "file": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BannerView.swift", + "line": 482, + "symbol": "BannerView.viewControllerForPresentingModal", + "symbol_kind": "source.lang.swift.decl.var.instance", + "warning": "undocumented" + } + ], + "source_directory": "/Users/runner/work/prebid-mobile-ios/prebid-mobile-ios" +} \ No newline at end of file