@jolibox/sdk 0.0.7 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README-zh_cn.md +1 -1
- package/README.md +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/ads.JoliboxAds.html +41 -0
- package/docs/classes/index.JoliboxSDK.html +2 -2
- package/docs/classes/loader.JoliboxSDKLoader.html +7 -0
- package/docs/classes/{index.JoliboxRuntime.html → runtime.JoliboxRuntime.html} +5 -5
- package/docs/documents/README.html +7 -8
- package/docs/enums/{index.JoliboxRuntimeEvents.html → runtime.JoliboxRuntimeEvents.html} +3 -3
- package/docs/index.html +7 -8
- package/docs/interfaces/{index.IAdConfigParams.html → ads.IAdConfigParams.html} +3 -3
- package/docs/interfaces/{index.IAdUnitParams.html → ads.IAdUnitParams.html} +6 -6
- package/docs/interfaces/{index.IAdsInitParams.html → ads.IAdsInitParams.html} +2 -2
- package/docs/interfaces/{index.IInterstitialsParams.html → ads.IInterstitialsParams.html} +7 -7
- package/docs/interfaces/{index.IPlacementInfo.html → ads.IPlacementInfo.html} +5 -5
- package/docs/interfaces/{index.IPrerollParams.html → ads.IPrerollParams.html} +5 -5
- package/docs/interfaces/{index.IRewardParams.html → ads.IRewardParams.html} +10 -10
- package/docs/interfaces/index.IJoliboxConfig.html +2 -2
- package/docs/interfaces/loader.IJoliboxSDKLoaderConfig.html +3 -0
- package/docs/interfaces/loader.IRemoteVersionMetadata.html +4 -0
- package/docs/interfaces/{index.IVersionMetadata.html → loader.IVersionMetadata.html} +3 -3
- package/docs/modules/ads.html +12 -0
- package/docs/modules/index.html +3 -17
- package/docs/modules/loader.html +5 -0
- package/docs/modules/runtime.html +4 -0
- package/docs/modules.html +5 -2
- package/docs/types/{index.AdUnitFormat.html → ads.AdUnitFormat.html} +1 -1
- package/docs/types/{index.IAdBreakParams.html → ads.IAdBreakParams.html} +1 -1
- package/package.json +9 -9
- package/typedoc.config.mjs +3 -1
- package/docs/classes/index.JoliboxAds.html +0 -41
- package/docs/interfaces/index.IJoliboxSDKLoaderConfig.html +0 -3
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JoliboxRuntimeEvents | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=
|
|
2
|
-
<a href="
|
|
3
|
-
<a href="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JoliboxRuntimeEvents | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="../assets/highlight.css?cache=1729836066439"/><script defer src="../assets/main.js?cache=1729836066439"></script><script async src="../assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@jolibox/sdk</a></li><li><a href="../modules/runtime.html">runtime</a></li><li><a href="runtime.JoliboxRuntimeEvents.html">JoliboxRuntimeEvents</a></li></ul><h1> EnumerationJoliboxRuntimeEvents</h1></div><aside class="tsd-sources"><ul><li>Defined in web-sync-sdk/dist/index.d.ts:7</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="runtime.JoliboxRuntimeEvents.html#LOAD_FINISHED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOAD_<wbr/>FINISHED</span></a>
|
|
2
|
+
<a href="runtime.JoliboxRuntimeEvents.html#LOAD_PROGRESS" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOAD_<wbr/>PROGRESS</span></a>
|
|
3
|
+
<a href="runtime.JoliboxRuntimeEvents.html#LOAD_START" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOAD_<wbr/>START</span></a>
|
|
4
4
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="LOAD_FINISHED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>LOAD_<wbr/>FINISHED</span><a href="#LOAD_FINISHED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">LOAD_<wbr/>FINISHED</span></div><div class="tsd-comment tsd-typography"><p>Event dispatched when the loading is finished</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in web-sync-sdk/dist/index.d.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="LOAD_PROGRESS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>LOAD_<wbr/>PROGRESS</span><a href="#LOAD_PROGRESS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">LOAD_<wbr/>PROGRESS</span></div><div class="tsd-comment tsd-typography"><p>Event dispatched when the loading progress is updated</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in web-sync-sdk/dist/index.d.ts:19</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="LOAD_START" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>LOAD_<wbr/>START</span><a href="#LOAD_START" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">LOAD_<wbr/>START</span></div><div class="tsd-comment tsd-typography"><p>Event dispatched when the loading starts</p>
|
package/docs/index.html
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css?cache=
|
|
2
|
-
<p>Most functions are strictly follow Ad Placement API design. You can read Google's official documentations <a href="https://developers.google.com/ad-placement" target="_blank" class="external">here</a></p>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="assets/highlight.css?cache=1729836066439"/><script defer src="assets/main.js?cache=1729836066439"></script><script async src="assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@jolibox/sdk</h1></div><div class="tsd-panel tsd-typography"><a id="md:jolibox-sdk" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Jolibox SDK<a href="#md:jolibox-sdk" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Jolibox SDK is a JavaScript library that provides a simple way to integrate with Jolibox Ads, Runtime, and other services.</p>
|
|
3
2
|
<p><strong>The current version is still in pre-release, so the API may change in the future.</strong></p>
|
|
4
3
|
<a id="md:installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:via-cdn" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Via CDN<a href="#md:via-cdn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>If you want to use the library via CDN, you add the following script tag to your HTML file.</p>
|
|
5
4
|
<p>In such case, you should not write the import statement in your JavaScript file.</p>
|
|
6
|
-
<pre><code class="html"><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-2"> </span><span class="hl-3">src</span><span class="hl-2">=</span><span class="hl-4">"https://cdn.jsdelivr.net/npm/@jolibox/
|
|
5
|
+
<pre><code class="html"><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-2"> </span><span class="hl-3">src</span><span class="hl-2">=</span><span class="hl-4">"https://cdn.jsdelivr.net/npm/@jolibox/sdk@0.0.8/dist/index.iife.js"</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span>
|
|
7
6
|
</code><button type="button">Copy</button></pre>
|
|
8
7
|
|
|
9
8
|
<a id="md:via-npm" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Via NPM<a href="#md:via-npm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>If you want to use the library via NPM, you can install it via the following command:</p>
|
|
@@ -11,19 +10,19 @@
|
|
|
11
10
|
<ul>
|
|
12
11
|
<li>
|
|
13
12
|
<p>npm</p>
|
|
14
|
-
<pre><code class="bash"><span class="hl-5">npm</span><span class="hl-6"> </span><span class="hl-7">install</span><span class="hl-6"> </span><span class="hl-7">@jolibox/
|
|
13
|
+
<pre><code class="bash"><span class="hl-5">npm</span><span class="hl-6"> </span><span class="hl-7">install</span><span class="hl-6"> </span><span class="hl-7">@jolibox/sdk</span>
|
|
15
14
|
</code><button type="button">Copy</button></pre>
|
|
16
15
|
|
|
17
16
|
</li>
|
|
18
17
|
<li>
|
|
19
18
|
<p>pnpm</p>
|
|
20
|
-
<pre><code class="bash"><span class="hl-5">pnpm</span><span class="hl-6"> </span><span class="hl-7">add</span><span class="hl-6"> </span><span class="hl-7">@jolibox/
|
|
19
|
+
<pre><code class="bash"><span class="hl-5">pnpm</span><span class="hl-6"> </span><span class="hl-7">add</span><span class="hl-6"> </span><span class="hl-7">@jolibox/sdk</span>
|
|
21
20
|
</code><button type="button">Copy</button></pre>
|
|
22
21
|
|
|
23
22
|
</li>
|
|
24
23
|
<li>
|
|
25
24
|
<p>yarn</p>
|
|
26
|
-
<pre><code class="bash"><span class="hl-5">yarn</span><span class="hl-6"> </span><span class="hl-7">add</span><span class="hl-6"> </span><span class="hl-7">@jolibox/
|
|
25
|
+
<pre><code class="bash"><span class="hl-5">yarn</span><span class="hl-6"> </span><span class="hl-7">add</span><span class="hl-6"> </span><span class="hl-7">@jolibox/sdk</span>
|
|
27
26
|
</code><button type="button">Copy</button></pre>
|
|
28
27
|
|
|
29
28
|
</li>
|
|
@@ -31,9 +30,9 @@
|
|
|
31
30
|
<a id="md:basic-usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Basic usage<a href="#md:basic-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
32
31
|
<li>
|
|
33
32
|
<p>Initialization</p>
|
|
34
|
-
<pre><code class="typescript"><span class="hl-8">// If you are importing the library via NPM, you can use the following import statement</span><br/><span class="hl-8">// import {
|
|
33
|
+
<pre><code class="typescript"><span class="hl-8">// If you are importing the library via NPM, you can use the following import statement</span><br/><span class="hl-8">// import { JoliboxSDK } from "@jolibox/sdk";</span><br/><br/><span class="hl-9">const</span><span class="hl-6"> </span><span class="hl-10">jolibox</span><span class="hl-6"> = </span><span class="hl-9">new</span><span class="hl-6"> </span><span class="hl-5">JoliboxSDK</span><span class="hl-6">({</span><br/><span class="hl-6"> </span><span class="hl-11">loaderConfig:</span><span class="hl-6"> {</span><br/><span class="hl-6"> </span><span class="hl-11">testMode:</span><span class="hl-6"> </span><span class="hl-9">true</span><span class="hl-6">,</span><br/><span class="hl-6"> },</span><br/><span class="hl-6">});</span><br/><br/><span class="hl-8">// For example, if you want to use the Ads service</span><br/><span class="hl-9">const</span><span class="hl-6"> { </span><span class="hl-10">ads</span><span class="hl-6"> } = </span><span class="hl-11">jolibox</span><span class="hl-6">;</span><br/><span class="hl-11">ads</span><span class="hl-6">.</span><span class="hl-5">init</span><span class="hl-6">({ </span><span class="hl-11">testMode:</span><span class="hl-6"> </span><span class="hl-9">true</span><span class="hl-6"> });</span><br/><br/><span class="hl-8">// somewhere when you need to preload ads (e.g. in the game loading screen)</span><br/><span class="hl-11">ads</span><span class="hl-6">.</span><span class="hl-5">adConfig</span><span class="hl-6">({</span><br/><span class="hl-6"> </span><span class="hl-11">preloadAdBreaks:</span><span class="hl-6"> </span><span class="hl-7">"on"</span><span class="hl-6">,</span><br/><span class="hl-6"> </span><span class="hl-11">sound:</span><span class="hl-6"> </span><span class="hl-7">"on"</span><span class="hl-6">,</span><br/><span class="hl-6"> </span><span class="hl-5">onReady</span><span class="hl-11">:</span><span class="hl-6"> () </span><span class="hl-9">=></span><span class="hl-6"> {</span><br/><span class="hl-6"> </span><span class="hl-11">console</span><span class="hl-6">.</span><span class="hl-5">log</span><span class="hl-6">(</span><span class="hl-7">"onReady"</span><span class="hl-6">);</span><br/><span class="hl-6"> },</span><br/><span class="hl-6">});</span><br/><br/><span class="hl-8">// Somewhere when you need a popup ads for reward</span><br/><span class="hl-11">ads</span><span class="hl-6">.</span><span class="hl-5">adBreak</span><span class="hl-6">({</span><br/><span class="hl-6"> </span><span class="hl-11">type:</span><span class="hl-6"> </span><span class="hl-7">"reward"</span><span class="hl-6">,</span><br/><span class="hl-6"> </span><span class="hl-5">beforeReward</span><span class="hl-6">(</span><span class="hl-11">showAdFn</span><span class="hl-6">) {</span><br/><span class="hl-6"> </span><span class="hl-5">showAdFn</span><span class="hl-6">();</span><br/><span class="hl-6"> },</span><br/><span class="hl-6"> </span><span class="hl-5">adDismissed</span><span class="hl-11">:</span><span class="hl-6"> () </span><span class="hl-9">=></span><span class="hl-6"> {</span><br/><span class="hl-6"> </span><span class="hl-11">console</span><span class="hl-6">.</span><span class="hl-5">log</span><span class="hl-6">(</span><span class="hl-7">"adDismissed"</span><span class="hl-6">);</span><br/><span class="hl-6"> },</span><br/><span class="hl-6"> </span><span class="hl-5">adViewed</span><span class="hl-11">:</span><span class="hl-6"> () </span><span class="hl-9">=></span><span class="hl-6"> {</span><br/><span class="hl-6"> </span><span class="hl-11">console</span><span class="hl-6">.</span><span class="hl-5">log</span><span class="hl-6">(</span><span class="hl-7">"adViewed"</span><span class="hl-6">);</span><br/><span class="hl-6"> },</span><br/><span class="hl-6"> </span><span class="hl-5">adBreakDone</span><span class="hl-11">:</span><span class="hl-6"> () </span><span class="hl-9">=></span><span class="hl-6"> {</span><br/><span class="hl-6"> </span><span class="hl-11">console</span><span class="hl-6">.</span><span class="hl-5">log</span><span class="hl-6">(</span><span class="hl-7">"adBreakDone"</span><span class="hl-6">);</span><br/><span class="hl-6"> },</span><br/><span class="hl-6">});</span><br/><br/><span class="hl-8">// If you need to show a banner ad, you should call the following function when you start the App</span><br/><span class="hl-11">ads</span><span class="hl-6">.</span><span class="hl-5">adUnit</span><span class="hl-6">({</span><br/><span class="hl-6"> </span><span class="hl-11">el:</span><span class="hl-6"> </span><span class="hl-7">"#banner"</span><span class="hl-6">, </span><span class="hl-8">// or document.getElementById("banner")</span><br/><span class="hl-6">});</span>
|
|
35
34
|
</code><button type="button">Copy</button></pre>
|
|
36
35
|
|
|
37
36
|
</li>
|
|
38
37
|
</ul>
|
|
39
|
-
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:jolibox-
|
|
38
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:jolibox-sdk"><span>Jolibox SDK</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li><li><ul><li><a href="#md:via-cdn"><span>Via CDN</span></a></li><li><a href="#md:via-npm"><span>Via NPM</span></a></li></ul></li><li><a href="#md:basic-usage"><span>Basic usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@jolibox/sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAdConfigParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=
|
|
2
|
-
<a href="
|
|
3
|
-
<a href="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAdConfigParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="../assets/highlight.css?cache=1729836066439"/><script defer src="../assets/main.js?cache=1729836066439"></script><script async src="../assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@jolibox/sdk</a></li><li><a href="../modules/ads.html">ads</a></li><li><a href="ads.IAdConfigParams.html">IAdConfigParams</a></li></ul><h1> InterfaceIAdConfigParams</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IAdConfigParams</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdConfigParams.html#onReady">onReady</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdConfigParams.html#preloadAdBreaks">preloadAdBreaks</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"on"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdConfigParams.html#sound">sound</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"on"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"off"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:19</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ads.IAdConfigParams.html#onReady" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Ready?</span></a>
|
|
2
|
+
<a href="ads.IAdConfigParams.html#preloadAdBreaks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preload<wbr/>Ad<wbr/>Breaks?</span></a>
|
|
3
|
+
<a href="ads.IAdConfigParams.html#sound" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sound?</span></a>
|
|
4
4
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="onReady" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Ready</span><a href="#onReady" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Ready</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Called when the API has initialized and has finished preloading ads (if you requested preloading using the preloadAdBreaks above).</p>
|
|
5
5
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="onReady.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:44</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="preloadAdBreaks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>preload<wbr/>Ad<wbr/>Breaks</span><a href="#preloadAdBreaks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">preload<wbr/>Ad<wbr/>Breaks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"on"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"auto"</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Whether ads should always be preloaded before the first call to adBreak()</p>
|
|
6
6
|
<p>The default value of auto leaves the decision up to the Ad Placement API. preloadAdBreaks can be set only once with adConfig(), and further values passed to preloadAdBreaks have no effect.</p>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAdUnitParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=
|
|
2
|
-
<a href="
|
|
3
|
-
<a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="adFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ad<wbr/>Format</span><a href="#adFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ad<wbr/>Format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> | </span><a href="../types/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAdUnitParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="../assets/highlight.css?cache=1729836066439"/><script defer src="../assets/main.js?cache=1729836066439"></script><script async src="../assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@jolibox/sdk</a></li><li><a href="../modules/ads.html">ads</a></li><li><a href="ads.IAdUnitParams.html">IAdUnitParams</a></li></ul><h1> InterfaceIAdUnitParams</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IAdUnitParams</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdUnitParams.html#adFormat">adFormat</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> | </span><a href="../types/ads.AdUnitFormat.html" class="tsd-signature-type tsd-kind-type-alias">AdUnitFormat</a><span class="tsd-signature-symbol"> | </span><a href="../types/ads.AdUnitFormat.html" class="tsd-signature-type tsd-kind-type-alias">AdUnitFormat</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdUnitParams.html#el">el</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdUnitParams.html#fullWidthResponsive">fullWidthResponsive</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"true"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"false"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdUnitParams.html#slot">slot</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdUnitParams.html#style">style</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:208</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ads.IAdUnitParams.html#adFormat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ad<wbr/>Format?</span></a>
|
|
2
|
+
<a href="ads.IAdUnitParams.html#el" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>el</span></a>
|
|
3
|
+
<a href="ads.IAdUnitParams.html#fullWidthResponsive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>full<wbr/>Width<wbr/>Responsive?</span></a>
|
|
4
|
+
<a href="ads.IAdUnitParams.html#slot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>slot?</span></a>
|
|
5
|
+
<a href="ads.IAdUnitParams.html#style" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style?</span></a>
|
|
6
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="adFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ad<wbr/>Format</span><a href="#adFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ad<wbr/>Format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> | </span><a href="../types/ads.AdUnitFormat.html" class="tsd-signature-type tsd-kind-type-alias">AdUnitFormat</a><span class="tsd-signature-symbol"> | </span><a href="../types/ads.AdUnitFormat.html" class="tsd-signature-type tsd-kind-type-alias">AdUnitFormat</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Ad format for the ad unit. Can be 'auto' or a single format or an array of formats. Default is 'auto'. If passed as an array, the array will be joined by ', ' and pass to the data-ad-format attribute.</p>
|
|
7
7
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:232</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="el" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>el</span><a href="#el" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">el</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></div><div class="tsd-comment tsd-typography"><p>The element to attach the ad unit to, either an HTMLElement or a string selector. Should be the parent element of the ad unit (<ins> tag).</p>
|
|
8
8
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:212</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fullWidthResponsive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>full<wbr/>Width<wbr/>Responsive</span><a href="#fullWidthResponsive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">full<wbr/>Width<wbr/>Responsive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"true"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"false"</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Whether the ad unit should be full width and responsive. Default is false.</p>
|
|
9
9
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:237</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="slot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>slot</span><a href="#slot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">slot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Reserved for future usage. The slot ID of the ad unit. Currently the slot ID is automatically set by the SDK.</p>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAdsInitParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=
|
|
2
|
-
<a href="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAdsInitParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="../assets/highlight.css?cache=1729836066439"/><script defer src="../assets/main.js?cache=1729836066439"></script><script async src="../assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@jolibox/sdk</a></li><li><a href="../modules/ads.html">ads</a></li><li><a href="ads.IAdsInitParams.html">IAdsInitParams</a></li></ul><h1> InterfaceIAdsInitParams</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IAdsInitParams</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdsInitParams.html#gameId">gameId</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IAdsInitParams.html#testMode">testMode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:7</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ads.IAdsInitParams.html#gameId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>game<wbr/>Id?</span></a>
|
|
2
|
+
<a href="ads.IAdsInitParams.html#testMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>test<wbr/>Mode?</span></a>
|
|
3
3
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="gameId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>game<wbr/>Id</span><a href="#gameId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">game<wbr/>Id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Game ID provided by Jolibox</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="testMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>test<wbr/>Mode</span><a href="#testMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">test<wbr/>Mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Enable "data-adbreak-test" attributes, default false</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:11</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#gameId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>game<wbr/>Id</span></a><a href="#testMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>test<wbr/>Mode</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@jolibox/sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IInterstitialsParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=
|
|
2
|
-
<a href="
|
|
3
|
-
<a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="adBreakDone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ad<wbr/>Break<wbr/>Done</span><a href="#adBreakDone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ad<wbr/>Break<wbr/>Done</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">placementInfo</span><span class="tsd-signature-symbol">: </span><a href="
|
|
7
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="adBreakDone.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">placementInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">placementInfo</span>: <a href="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IInterstitialsParams | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="../assets/highlight.css?cache=1729836066439"/><script defer src="../assets/main.js?cache=1729836066439"></script><script async src="../assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@jolibox/sdk</a></li><li><a href="../modules/ads.html">ads</a></li><li><a href="ads.IInterstitialsParams.html">IInterstitialsParams</a></li></ul><h1> InterfaceIInterstitialsParams</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IInterstitialsParams</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ads.IInterstitialsParams.html#adBreakDone">adBreakDone</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">placementInfo</span><span class="tsd-signature-symbol">: </span><a href="ads.IPlacementInfo.html" class="tsd-signature-type tsd-kind-interface">IPlacementInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IInterstitialsParams.html#afterAd">afterAd</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IInterstitialsParams.html#beforeAd">beforeAd</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IInterstitialsParams.html#name">name</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IInterstitialsParams.html#type">type</a><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pause"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"next"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"browse"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:113</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ads.IInterstitialsParams.html#adBreakDone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ad<wbr/>Break<wbr/>Done?</span></a>
|
|
2
|
+
<a href="ads.IInterstitialsParams.html#afterAd" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>after<wbr/>Ad?</span></a>
|
|
3
|
+
<a href="ads.IInterstitialsParams.html#beforeAd" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>before<wbr/>Ad?</span></a>
|
|
4
|
+
<a href="ads.IInterstitialsParams.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name?</span></a>
|
|
5
|
+
<a href="ads.IInterstitialsParams.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
6
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="adBreakDone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ad<wbr/>Break<wbr/>Done</span><a href="#adBreakDone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ad<wbr/>Break<wbr/>Done</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">placementInfo</span><span class="tsd-signature-symbol">: </span><a href="ads.IPlacementInfo.html" class="tsd-signature-type tsd-kind-interface">IPlacementInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Always called as the last step in an adBreak(), even if there was no ad shown. Function takes as argument a placementInfo object</p>
|
|
7
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="adBreakDone.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">placementInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">placementInfo</span>: <a href="ads.IPlacementInfo.html" class="tsd-signature-type tsd-kind-interface">IPlacementInfo</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:148</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="afterAd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>after<wbr/>Ad</span><a href="#afterAd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">after<wbr/>Ad</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="afterAd.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>(OPTIONAL) Called after the ad is finished (for any reason). For rewarded ads, it is called after either adDismissed or adViewed, depending on player actions. This function should be used to resume game flow. For example, use to unmute the sound and start the next level.</p>
|
|
8
8
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:140</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="beforeAd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>before<wbr/>Ad</span><a href="#beforeAd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">before<wbr/>Ad</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) Called before the ad is displayed. The game should pause and mute the sound. These actions must be done synchronously. The ad will be displayed immediately after this callback finishes.</p>
|
|
9
9
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="beforeAd.__type-4.__type-5"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:134</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>(OPTIONAL) a name for this particular ad placement within your game. It is an internal identifier, and is not shown to the player. In future releases this identifier may be used to enable additional reporting and optimization features.</p>
|
|
10
10
|
<p>We recommend you name all of your placements.</p>
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPlacementInfo | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IPlacementInfo</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="
|
|
3
|
-
<a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPlacementInfo | @jolibox/sdk</title><meta name="description" content="Documentation for @jolibox/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1729836066439"/><link rel="stylesheet" href="../assets/highlight.css?cache=1729836066439"/><script defer src="../assets/main.js?cache=1729836066439"></script><script async src="../assets/icons.js?cache=1729836066439" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1729836066439" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1729836066439" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@jolibox/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@jolibox/sdk</a></li><li><a href="../modules/ads.html">ads</a></li><li><a href="ads.IPlacementInfo.html">IPlacementInfo</a></li></ul><h1> InterfaceIPlacementInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>PlacementInfo object passed by <strong>adBreakDone</strong> function</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IPlacementInfo</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ads.IPlacementInfo.html#breakFormat">breakFormat</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"interstitial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reward"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IPlacementInfo.html#breakName">breakName</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IPlacementInfo.html#breakStatus">breakStatus</a><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"notReady"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"timeout"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"noAdPreloaded"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"frequencyCapped"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"ignored"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"other"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"dismissed"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"viewed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ads.IPlacementInfo.html#breakType">breakType</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:50</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ads.IPlacementInfo.html#breakFormat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>break<wbr/>Format</span></a>
|
|
3
|
+
<a href="ads.IPlacementInfo.html#breakName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>break<wbr/>Name</span></a>
|
|
4
|
+
<a href="ads.IPlacementInfo.html#breakStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>break<wbr/>Status</span></a>
|
|
5
|
+
<a href="ads.IPlacementInfo.html#breakType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>break<wbr/>Type</span></a>
|
|
6
6
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="breakFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>break<wbr/>Format</span><a href="#breakFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">break<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"interstitial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reward"</span></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:59</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="breakName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>break<wbr/>Name</span><a href="#breakName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">break<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>the name argument passed to adBreak()</p>
|
|
7
7
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sdk/src/ads/index.ts:58</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="breakStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>break<wbr/>Status</span><a href="#breakStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">break<wbr/>Status</span><span class="tsd-signature-symbol">:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"notReady"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"timeout"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"noAdPreloaded"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"frequencyCapped"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"ignored"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"other"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"dismissed"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"viewed"</span></div><div class="tsd-comment tsd-typography"><p>the status of this placement and can be one of the following values:</p>
|
|
8
8
|
<table>
|