Skip to content

Commit aab941f

Browse files
ShchvovaShchvova
committed
Adding binaries
1 parent 23a2c1e commit aab941f

25 files changed

Lines changed: 719 additions & 0 deletions

‎docs/kidoz/event/adsRequest/index.markdown‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# adsRequest
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [Event][api.type.Event]
5+
> __Revision__ [REVISION_LABEL](REVISION_URL)
6+
> __Keywords__ ads, advertising, KIDOZ, adsRequest
7+
> __See also__ [kidoz.init()][plugin.kidoz.init]
8+
> [kidoz.*][plugin.kidoz]
9+
> --------------------- ------------------------------------------------------------------------------------------
10+
11+
## Overview
12+
13+
The following event properties are passed to the listener function specified in [kidoz.init()][plugin.kidoz.init].
14+
15+
16+
## Properties
17+
18+
#### [event.isError][plugin.kidoz.event.adsRequest.isError]
19+
20+
#### [event.name][plugin.kidoz.event.adsRequest.name]
21+
22+
#### [event.phase][plugin.kidoz.event.adsRequest.phase]
23+
24+
#### [event.provider][plugin.kidoz.event.adsRequest.provider]
25+
26+
#### [event.response][plugin.kidoz.event.adsRequest.response]
27+
28+
#### [event.type][plugin.kidoz.event.adsRequest.type]

‎docs/kidoz/event/adsRequest/isError.markdown‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# event.isError
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [String][api.type.String]
5+
> __Event__ [adsRequest][plugin.kidoz.event.adsRequest]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, adsRequest, isError
8+
> __See also__ [adsRequest][plugin.kidoz.event.adsRequest]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
## Overview
13+
14+
[Boolean][api.type.Boolean] value indicating whether an error occurred.

‎docs/kidoz/event/adsRequest/name.markdown‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# event.name
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [String][api.type.String]
5+
> __Event__ [adsRequest][plugin.kidoz.event.adsRequest]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, adsRequest, name
8+
> __See also__ [adsRequest][plugin.kidoz.event.adsRequest]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
## Overview
13+
14+
The string `"adsRequest"`.

‎docs/kidoz/event/adsRequest/phase.markdown‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# event.phase
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [String][api.type.String]
5+
> __Event__ [adsRequest][plugin.kidoz.event.adsRequest]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, adsRequest, phase
8+
> __See also__ [adsRequest][plugin.kidoz.event.adsRequest]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
## Overview
13+
14+
[String][api.type.String] value indicating the phase of the [adsRequest][plugin.kidoz.event.adsRequest] event. Possible values include:
15+
16+
* `"init"` — Indicates that the KIDOZ plugin was initialized successfully.
17+
18+
* `"failed"` — Indicates that an ad failed to load or that the plugin failed to initialize. When an ad fails to load, [event.type][plugin.kidoz.event.adsRequest.type] can provide additional context. When the plugin fails to initialize [event.response][plugin.kidoz.event.adsRequest.response] can provide additional context.
19+
20+
* `"loaded"` — Indicates that an ad loaded successfully. For this phase, [event.type][plugin.kidoz.event.adsRequest.type] can provide additional context.
21+
22+
* `"displayed"` — Indicates that an ad was displayed. For this phase, [event.type][plugin.kidoz.event.adsRequest.type] can provide additional context.
23+
24+
* `"closed"` — Indicates that an ad was closed. For this phase, [event.type][plugin.kidoz.event.adsRequest.type] can provide additional context.
25+
26+
* `"reward"` — Indicates that a rewarded video has completed. For this phase, [event.type][plugin.kidoz.event.adsRequest.type] will be `"rewardedVideo"`.
27+
28+
* `"playbackBegan"` — Indicates that a rewarded video has began playback. For this phase, [event.type][plugin.kidoz.event.adsRequest.type] will be `"rewardedVideo"`.

‎docs/kidoz/event/adsRequest/provider.markdown‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# event.provider
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [String][api.type.String]
5+
> __Event__ [adsRequest][plugin.kidoz.event.adsRequest]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, adsRequest, provider
8+
> __See also__ [adsRequest][plugin.kidoz.event.adsRequest]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
## Overview
13+
14+
The string `"kidoz"`.

‎docs/kidoz/event/adsRequest/response.markdown‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# event.response
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [String][api.type.String]
5+
> __Event__ [adsRequest][plugin.kidoz.event.adsRequest]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, adsRequest, response
8+
> __See also__ [adsRequest][plugin.kidoz.event.adsRequest]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
## Overview
13+
14+
If the plugin fails to initialize, a [string][api.type.String] value response stating the reason.

‎docs/kidoz/event/adsRequest/type.markdown‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# event.type
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [String][api.type.String]
5+
> __Event__ [adsRequest][plugin.kidoz.event.adsRequest]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, adsRequest, type
8+
> __See also__ [adsRequest][plugin.kidoz.event.adsRequest]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
## Overview
13+
14+
The type of ad that was loaded, displayed, or closed. If [event.phase][plugin.kidoz.event.adsRequest.phase] is `"failed"`, indicates the type of ad that failed to load.

‎docs/kidoz/hide.markdown‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# kidoz.hide()
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [Function][api.type.Function]
5+
> __Return value__ none
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, hide
8+
> __See also__ [kidoz.show()][plugin.kidoz.show]
9+
> [kidoz.*][plugin.kidoz]
10+
> --------------------- ------------------------------------------------------------------------------------------
11+
12+
13+
## Overview
14+
15+
Hides a KIDOZ ad which was previously shown via [kidoz.show()][plugin.kidoz.show].
16+
17+
## Syntax
18+
19+
kidoz.hide( adType )
20+
21+
##### adType ~^(required)^~
22+
_[String][api.type.String]._ The ad type to hide. Valid values include `"panelView"`, and `"banner"`.
23+
24+
25+
## Example
26+
27+
``````lua
28+
local kidoz = require( "plugin.kidoz" )
29+
30+
local function adListener( event )
31+
32+
if ( event.phase == "init" ) then -- Successful initialization
33+
print( event.provider )
34+
-- Load a KIDOZ panel view ad
35+
kidoz.load( "panelView", { adPosition="bottom" } )
36+
37+
elseif ( event.phase == "loaded" ) then -- The ad was successfully loaded
38+
print( event.type )
39+
-- Show the ad
40+
kidoz.show( "panelView" )
41+
end
42+
end
43+
44+
-- Initialize the KIDOZ plugin
45+
kidoz.init( adListener, { publisherID="YOUR_PUBLISHER_ID", securityToken="YOUR_SECURITY_TOKEN" } )
46+
47+
-- Sometime later, hide the panel view
48+
kidoz.hide( "panelView" )
49+
``````

‎docs/kidoz/index.markdown‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
2+
# kidoz.*
3+
4+
> --------------------- ------------------------------------------------------------------------------------------
5+
> __Type__ [Library][api.type.Library]
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ
8+
> __Platforms__ Android, iOS
9+
> --------------------- ------------------------------------------------------------------------------------------
10+
11+
## Overview
12+
13+
<!---
14+
15+
<div class="float-right" style="max-width: 240px; clear: both;">
16+
17+
![][images.docs.plugin-screenshot-kidoz]
18+
19+
</div>
20+
21+
-->
22+
23+
KIDOZ is a child-friendly content discovery platform, allowing you to boost app revenue and
24+
engagement without compromising on user experience and fun. Unique features include:
25+
26+
* [COPPA](https://www.ftc.gov/enforcement/rules/rulemaking-regulatory-reform-proceedings/childrens-online-privacy-protection-rule) compliant in accordance with Federal Trade Commission laws regulating children's digital privacy and safety.
27+
* Unlike most ad networks, apps using KIDOZ can be included in the family section of the Google&nbsp;Play&nbsp;Store according to Google's [Designed for Families](https://developer.android.com/distribute/googleplay/families/about.html) program requirements.
28+
* Non-intrusive SDK specially made for kids which keeps your app nice and clean.
29+
30+
<div class="guide-notebox">
31+
<div class="notebox-title">Note</div>
32+
33+
FeedView type ads were deprecated in plugin version 1.4.2 (KIDOZ sdk version 0.8.3.2) and are no longer available.
34+
35+
FlexiView and VideoUnit type ads were deprecated in plugin version 1.4.5 (KIDOZ sdk version 0.8.5.1) and are no longer available.
36+
37+
</div>
38+
39+
40+
## Registration
41+
42+
Before you can use this plugin, you must [register](http://accounts.kidoz.net/publishers/register) with KIDOZ.
43+
44+
45+
## Syntax
46+
47+
local kidoz = require( "plugin.kidoz" )
48+
49+
50+
## Functions
51+
52+
#### [kidoz.init()][plugin.kidoz.init]
53+
54+
#### [kidoz.load()][plugin.kidoz.load]
55+
56+
#### [kidoz.show()][plugin.kidoz.show]
57+
58+
#### [kidoz.hide()][plugin.kidoz.hide]
59+
60+
#### [kidoz.isLoaded()][plugin.kidoz.isLoaded]
61+
62+
63+
## Events
64+
65+
#### [adsRequest][plugin.kidoz.event.adsRequest]
66+
67+
68+
## Project Settings
69+
70+
To use this plugin, add an entry into the `plugins` table of `build.settings`. When added, the build server will integrate the plugin during the build phase.
71+
72+
``````{ brush="lua" gutter="false" first-line="1" highlight="[5,6,7,8]" }
73+
settings =
74+
{
75+
plugins =
76+
{
77+
["plugin.kidoz"] =
78+
{
79+
publisherId = "com.coronalabs"
80+
},
81+
},
82+
}
83+
``````
84+
85+
In addition, please add the following entry to the <nobr>`settings` &rarr; `android`</nobr> table of `build.settings` to prevent your app from being installed on incompatible Android devices.
86+
87+
``````{ brush="lua" gutter="false" first-line="1" highlight="[5]" }
88+
settings =
89+
{
90+
android =
91+
{
92+
minSdkVersion = "17",
93+
},
94+
}
95+
``````
96+
97+
<div class="guide-notebox">
98+
<div class="notebox-title">Note</div>
99+
100+
For Android, the following permissions/features are automatically added when using this plugin:
101+
102+
* `"android.permission.INTERNET"`
103+
* `"android.permission.WRITE_EXTERNAL_STORAGE"`
104+
105+
</div>

‎docs/kidoz/init.markdown‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# kidoz.init()
2+
3+
> --------------------- ------------------------------------------------------------------------------------------
4+
> __Type__ [Function][api.type.Function]
5+
> __Return value__ none
6+
> __Revision__ [REVISION_LABEL](REVISION_URL)
7+
> __Keywords__ ads, advertising, KIDOZ, init
8+
> __See also__ [kidoz.load()][plugin.kidoz.load]
9+
> [kidoz.show()][plugin.kidoz.show]
10+
> [kidoz.*][plugin.kidoz]
11+
> --------------------- ------------------------------------------------------------------------------------------
12+
13+
14+
## Overview
15+
16+
`kidoz.init()` initializes the KIDOZ plugin.
17+
18+
Once initialized, you can load an ad using [kidoz.load()][plugin.kidoz.load] and subsequently show it via [kidoz.show()][plugin.kidoz.show].
19+
20+
<div class="guide-notebox">
21+
<div class="notebox-title">Note</div>
22+
23+
This call requires your KIDOZ publisher&nbsp;ID and security token, obtained from the [KIDOZ developer portal](http://accounts.kidoz.net/publishers/login).
24+
25+
</div>
26+
27+
28+
## Syntax
29+
30+
kidoz.init( adListener, params )
31+
32+
##### adListener ~^(required)^~
33+
_[Listener][api.type.Listener]._ Listener function that will receive [adsRequest][plugin.kidoz.event.adsRequest] events.
34+
35+
##### params ~^(required)^~
36+
_[Table][api.type.Table]._ Table containing KIDOZ initialization values &mdash; see the next section for details.
37+
38+
39+
## Parameter Reference
40+
41+
The `params` table includes parameters for the KIDOZ initialization.
42+
43+
##### publisherID ~^(required)^~
44+
_[String][api.type.String]._ Your publisher&nbsp;ID from KIDOZ.
45+
46+
##### securityToken ~^(required)^~
47+
_[String][api.type.String]._ Your security token from KIDOZ.
48+
49+
50+
## Example
51+
52+
``````lua
53+
local kidoz = require( "plugin.kidoz" )
54+
55+
local function adListener( event )
56+
57+
if ( event.phase == "init" ) then -- Successful initialization
58+
print( event.provider )
59+
end
60+
end
61+
62+
-- Initialize the KIDOZ plugin
63+
kidoz.init( adListener, { publisherID="YOUR_PUBLISHER_ID", securityToken="YOUR_SECURITY_TOKEN" } )
64+
``````

0 commit comments

Comments
 (0)