Skip to content

Commit

Permalink
Generate docs - 2.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Dec 20, 2024
1 parent b2f789d commit 35c2b8a
Show file tree
Hide file tree
Showing 180 changed files with 11,482 additions and 8,578 deletions.
92 changes: 60 additions & 32 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">PrebidMobile 2.3.0 Docs</a> (92% documented)</p>
<p><a href="index.html">PrebidMobile 2.3.1 Docs</a> (91% documented)</p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -53,9 +53,6 @@
<li class="nav-group-task">
<a href="Classes/BannerView.html">BannerView</a>
</li>
<li class="nav-group-task">
<a href="Classes/BaseInterstitialAdUnit.html">BaseInterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="Classes/BidInfo.html">BidInfo</a>
</li>
Expand Down Expand Up @@ -173,9 +170,15 @@
<li class="nav-group-task">
<a href="Classes/PrebidRequest.html">PrebidRequest</a>
</li>
<li class="nav-group-task">
<a href="Classes/PrebidReward.html">PrebidReward</a>
</li>
<li class="nav-group-task">
<a href="Classes/RewardedAdUnit.html">RewardedAdUnit</a>
</li>
<li class="nav-group-task">
<a href="Classes/RewardedConfig.html">RewardedConfig</a>
</li>
<li class="nav-group-task">
<a href="Classes/RewardedVideoAdUnit.html">RewardedVideoAdUnit</a>
</li>
Expand Down Expand Up @@ -451,7 +454,7 @@ <h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">@objc(PBMBidInfo)</span>
<span class="kd">@objc</span><span class="p">(</span><span class="kt">PBMBidInfo</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BidInfo</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
Expand Down Expand Up @@ -625,7 +628,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc(PBMNativeAdConfiguration)</span>
<pre class="highlight swift"><code><span class="kd">@objc</span><span class="p">(</span><span class="kt">PBMNativeAdConfiguration</span><span class="p">)</span>
<span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">NativeAdConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

Expand Down Expand Up @@ -1057,7 +1060,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc(PBMNativeMarkupRequestObject)</span>
<pre class="highlight swift"><code><span class="kd">@objc</span><span class="p">(</span><span class="kt">PBMNativeMarkupRequestObject</span><span class="p">)</span>
<span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">NativeMarkupRequestObject</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span><span class="p">,</span> <span class="kt">PBMJsonCodable</span></code></pre>

Expand Down Expand Up @@ -1376,7 +1379,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "This class is deprecated. Please, use BannerAdUnit with video adFormat.")</span>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"This class is deprecated. Please, use BannerAdUnit with video adFormat."</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">VideoAdUnit</span> <span class="p">:</span> <span class="kt"><a href="Classes/AdUnit.html">AdUnit</a></span></code></pre>

</div>
Expand Down Expand Up @@ -1407,7 +1410,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")</span>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"This class is deprecated. Please, use InterstitialAdUnit with video adFormat."</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">VideoInterstitialAdUnit</span> <span class="p">:</span> <span class="kt"><a href="Classes/AdUnit.html">AdUnit</a></span></code></pre>

</div>
Expand Down Expand Up @@ -1589,7 +1592,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc(PBMVideoControlsConfiguration)</span>
<pre class="highlight swift"><code><span class="kd">@objc</span><span class="p">(</span><span class="kt">PBMVideoControlsConfiguration</span><span class="p">)</span>
<span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">VideoControlsConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

Expand Down Expand Up @@ -1719,31 +1722,26 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit"></a>
<a name="//apple_ref/swift/Class/BaseInterstitialAdUnit" class="dashAnchor"></a>
<a class="token" href="#/c:@M@PrebidMobile@objc(cs)BaseInterstitialAdUnit">BaseInterstitialAdUnit</a>
<a name="/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit"></a>
<a name="//apple_ref/swift/Class/InterstitialRenderingAdUnit" class="dashAnchor"></a>
<a class="token" href="#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit">InterstitialRenderingAdUnit</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A base class for interstitial ad units.</p>
<p>Represents an interstitial ad unit. Built for rendering type of integration.</p>

<a href="Classes/BaseInterstitialAdUnit.html" class="slightly-smaller">See more</a>
<a href="Classes/InterstitialRenderingAdUnit.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BaseInterstitialAdUnit</span> <span class="p">:</span>
<span class="kt">NSObject</span><span class="p">,</span>
<span class="kt">PBMInterstitialAdLoaderDelegate</span><span class="p">,</span>
<span class="kt">AdLoadFlowControllerDelegate</span><span class="p">,</span>
<span class="kt">InterstitialControllerInteractionDelegate</span><span class="p">,</span>
<span class="kt">InterstitialEventInteractionDelegate</span><span class="p">,</span>
<span class="kt">BaseInterstitialAdUnitProtocol</span></code></pre>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">InterstitialRenderingAdUnit</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">BaseInterstitialAdUnitProtocol</span></code></pre>

</div>
</div>
Expand All @@ -1753,26 +1751,26 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit"></a>
<a name="//apple_ref/swift/Class/InterstitialRenderingAdUnit" class="dashAnchor"></a>
<a class="token" href="#/c:@M@PrebidMobile@objc(cs)InterstitialRenderingAdUnit">InterstitialRenderingAdUnit</a>
<a name="/c:@M@PrebidMobile@objc(cs)PrebidReward"></a>
<a name="//apple_ref/swift/Class/PrebidReward" class="dashAnchor"></a>
<a class="token" href="#/c:@M@PrebidMobile@objc(cs)PrebidReward">PrebidReward</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Represents an interstitial ad unit. Built for rendering type of integration.</p>
<p>Undocumented</p>

<a href="Classes/InterstitialRenderingAdUnit.html" class="slightly-smaller">See more</a>
<a href="Classes/PrebidReward.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">InterstitialRenderingAdUnit</span> <span class="p">:</span> <span class="kt"><a href="Classes/BaseInterstitialAdUnit.html">BaseInterstitialAdUnit</a></span></code></pre>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">PrebidReward</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -1801,8 +1799,38 @@ <h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RewardedAdUnit</span><span class="p">:</span> <span class="kt"><a href="Classes/BaseInterstitialAdUnit.html">BaseInterstitialAdUnit</a></span><span class="p">,</span>
<span class="kt">RewardedEventInteractionDelegate</span></code></pre>
<span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RewardedAdUnit</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">BaseInterstitialAdUnitProtocol</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@PrebidMobile@objc(cs)PBMRewardedConfig"></a>
<a name="//apple_ref/swift/Class/RewardedConfig" class="dashAnchor"></a>
<a class="token" href="#/c:@M@PrebidMobile@objc(cs)PBMRewardedConfig">RewardedConfig</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

<a href="Classes/RewardedConfig.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span><span class="p">(</span><span class="kt">PBMRewardedConfig</span><span class="p">)</span>
<span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RewardedConfig</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -1963,8 +1991,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-09-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
19 changes: 11 additions & 8 deletions docs/Classes/AdFormat.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="AdFormat Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">PrebidMobile 2.3.0 Docs</a> (92% documented)</p>
<p><a href="../index.html">PrebidMobile 2.3.1 Docs</a> (91% documented)</p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -55,9 +55,6 @@
<li class="nav-group-task">
<a href="../Classes/BannerView.html">BannerView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/BaseInterstitialAdUnit.html">BaseInterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/BidInfo.html">BidInfo</a>
</li>
Expand Down Expand Up @@ -175,9 +172,15 @@
<li class="nav-group-task">
<a href="../Classes/PrebidRequest.html">PrebidRequest</a>
</li>
<li class="nav-group-task">
<a href="../Classes/PrebidReward.html">PrebidReward</a>
</li>
<li class="nav-group-task">
<a href="../Classes/RewardedAdUnit.html">RewardedAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/RewardedConfig.html">RewardedConfig</a>
</li>
<li class="nav-group-task">
<a href="../Classes/RewardedVideoAdUnit.html">RewardedVideoAdUnit</a>
</li>
Expand Down Expand Up @@ -428,7 +431,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">rawValue</span><span class="p">:</span> <span class="kt"><a href="../Classes/AdFormat.html#/s:12PrebidMobile8AdFormatC8RawValuea">RawValue</a></span><span class="p">,</span> <span class="nv">stringEquivalent</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">rawValue</span><span class="p">:</span> <span class="kt"><a href="../Classes/AdFormat.html#/s:12PrebidMobile8AdFormatC8RawValuea">RawValue</a></span><span class="p">,</span> <span class="nv">stringEquivalent</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -613,7 +616,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "Display ad format is deprecated. Please, use banner ad format instead.")</span>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Display ad format is deprecated. Please, use banner ad format instead."</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">display</span><span class="p">:</span> <span class="kt">AdFormat</span></code></pre>

</div>
Expand Down Expand Up @@ -653,8 +656,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-09-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 35c2b8a

Please sign in to comment.