Skip to content

Commit ccea8ad

Browse files
committed
Update Components Documentation
1 parent 4af2cee commit ccea8ad

File tree

23 files changed

+207
-197
lines changed

23 files changed

+207
-197
lines changed

docs/components/connectivity/bluetooth-client.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Category | Requires | Version |
66
|:--------:|:-------:|:--------:|
7-
|**Connectivity**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">6</span>|
7+
|**Connectivity**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">8</span>|
88

99
## Overview
1010

@@ -13,8 +13,9 @@ A non-visible component that acts as a bluetooth client.
1313
??? example "Permissions"
1414
* [android.permission.BLUETOOTH_SCAN](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH_SCAN)
1515
* [android.permission.BLUETOOTH_ADMIN](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH_ADMIN)
16-
* [android.permission.BLUETOOTH](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH)
1716
* [android.permission.BLUETOOTH_CONNECT](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH_CONNECT)
17+
* [android.permission.BLUETOOTH](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH)
18+
* [android.permission.BLUETOOTH_SCAN](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH_SCAN) if using [No Location Needed](#no-location-needed)
1819

1920
## Events
2021

@@ -289,6 +290,12 @@ Returns true if a connection to a Bluetooth device has been made.
289290

290291
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Is%20Connected%22,%20%22getter%22:%20true%7D"></div>
291292

293+
### No Location Needed
294+
295+
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span></span>
296+
297+
On Android 12 and later, indicates that Bluetooth is not used to determine the user's location.
298+
292299
### Secure
293300

294301
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>True</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

docs/components/connectivity/download.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Set whether this download may proceed over a roaming connection.
9292

9393
### Description
9494

95-
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>Downloading file..</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>
95+
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>Downloading file...</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>
9696

9797
Set the description that you will see in the download notification.
9898

@@ -174,7 +174,7 @@ If false you will see a toast message with a error message when a error is occur
174174

175175
### Title
176176

177-
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>Download..</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>
177+
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> <span class="chip chip-text">Default: <i>Download...</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>
178178

179179
Set the title that you will see in the download notification.
180180

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# In-App Review
2+
3+
{>> Non-Visible component<<}
4+
5+
| Category | Requires | Version |
6+
|:--------:|:-------:|:--------:|
7+
|**Experimental**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">1</span>|
8+
9+
## Overview
10+
11+
A non-visible component that lets the user review the app within the app.
12+
Note\: For this component to work correctly, set the MIN API to 21 (Android 5).
13+
14+
??? example "Permissions"
15+
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
16+
* [android.permission.FOREGROUND_SERVICE](https://developer.android.com/reference/android/Manifest.permission.html#FOREGROUND_SERVICE)
17+
18+
## Events
19+
20+
### Initialized
21+
22+
Use this event to check if the app is ready to request the user to review
23+
24+
<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22In-App%20Review%22,%20%22name%22:%20%22Initialized%22,%20%22param%22:%20%5B%5D%7D"></div>
25+
26+
### Review Closed
27+
28+
Use this event to know when the review popup was closed (this triggers always, even if the user did not review)
29+
30+
<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22In-App%20Review%22,%20%22name%22:%20%22Review%20Closed%22,%20%22param%22:%20%5B%5D%7D"></div>
31+
32+
## Methods
33+
34+
### Request Review
35+
36+
Launch the flow for a user to review the app
37+
38+
<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22In-App%20Review%22,%20%22name%22:%20%22Request%20Review%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>
39+
40+
## Properties
41+
42+
### Is Ready
43+
44+
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> - <span class="chip chip-bd">Blocks</span></span>
45+
46+
Check if the InApp Review component is ready to request a review
47+
48+
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22In-App%20Review%22,%20%22name%22:%20%22Is%20Ready%22,%20%22getter%22:%20true%7D"></div>
49+
50+
### Test Mode
51+
52+
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>false</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>
53+
54+
Whether it is testing mode enabled or not.
55+
56+
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22In-App%20Review%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20true%7D"></div>
57+
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22In-App%20Review%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20false%7D"></div>

docs/components/experimental/in-app-update.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Note\: For this component to work correctly, set the MIN API to 21 (Android 5).
1313

1414
??? example "Permissions"
1515
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
16+
* [android.permission.FOREGROUND_SERVICE](https://developer.android.com/reference/android/Manifest.permission.html#FOREGROUND_SERVICE)
1617

1718
## Events
1819

docs/components/experimental/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* [CloudDB](clouddb.md)
44
* [Custom Tabs](custom-tabs.md)
55
* [ExoPlayer](exoplayer.md)
6+
* [In-App Review](in-app-review.md)
67
* [In-App Update](in-app-update.md)
78
* [Notification](notification.md)
89
* [Shortcut Badge](shortcut-badge.md)

docs/components/media/player.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This component is best for long sound files, such as songs, while the `` Sound `
1717
??? example "Permissions"
1818
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
1919
* [android.permission.VIBRATE](https://developer.android.com/reference/android/Manifest.permission.html#VIBRATE)
20+
* [android.permission.READ_EXTERNAL_STORAGE](https://developer.android.com/reference/android/Manifest.permission.html#READ_EXTERNAL_STORAGE) if using [Source](#source)
21+
* [android.permission.READ_MEDIA_AUDIO](https://developer.android.com/reference/android/Manifest.permission.html#READ_MEDIA_AUDIO) if using [Source](#source)
2022

2123
## Events
2224

docs/components/media/sound.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ You might get an error if you attempt to play a sound immediately after setting
2121
??? example "Permissions"
2222
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
2323
* [android.permission.VIBRATE](https://developer.android.com/reference/android/Manifest.permission.html#VIBRATE)
24+
* [android.permission.READ_EXTERNAL_STORAGE](https://developer.android.com/reference/android/Manifest.permission.html#READ_EXTERNAL_STORAGE) if using [Source](#source)
2425

2526
## Methods
2627

docs/components/media/video-player.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ You can also set the media source to a URL that points to a streaming video, but
1616

1717
??? example "Permissions"
1818
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
19+
* [android.permission.READ_EXTERNAL_STORAGE](https://developer.android.com/reference/android/Manifest.permission.html#READ_EXTERNAL_STORAGE) if using [Source](#source)
1920

2021
## Events
2122

docs/components/mkdocs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,6 @@
195195
- Rewarded Ad: components/monetization/advertising/rewarded-ad.md
196196
- StartApp Banner: components/monetization/advertising/startapp-banner.md
197197
- StartApp Interstitial: components/monetization/advertising/startapp-interstitial.md
198-
- Unity Ads Banner: components/monetization/advertising/unity-ads-banner.md
199-
- Unity Ads Interstitial: components/monetization/advertising/unity-ads-interstitial.md
200198
- LEGO® MINDSTORMS®:
201199
- Overview: components/lego-mindstorms/index.md
202200
- EV3:
@@ -223,6 +221,7 @@
223221
- CloudDB: components/experimental/clouddb.md
224222
- Custom Tabs: components/experimental/custom-tabs.md
225223
- ExoPlayer: components/experimental/exoplayer.md
224+
- In-App Review: components/experimental/in-app-review.md
226225
- In-App Update: components/experimental/in-app-update.md
227226
- Notification: components/experimental/notification.md
228227
- Shortcut Badge: components/experimental/shortcut-badge.md

docs/components/monetization/advertising/applovin-interstitial.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ Called when an ad request failed. The message will display the reason for why th
6868

6969
## Methods
7070

71+
### Initialize
72+
73+
Initialize the AppLovin SDK. You should call this function before loading ads to ensure proper initialization.
74+
75+
<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Initialize%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>
76+
7177
### Is European User
7278

7379
<span class="chip chip-boolean">Returns: <i>Boolean</i></span>
@@ -98,9 +104,11 @@ Property for SdkKey
98104

99105
### Test Mode
100106

107+
:warning: ==**Deprecated**==
108+
101109
<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>
102110

103-
If you want to test the component then that this property to true. Then you will receive test ads.
111+
With AppLovin SDK 13.2.0+, test mode must be configured through the AppLovin dashboard. This property is maintained for backwards compatibility but has no effect.
104112

105113
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20true%7D"></div>
106114
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20false%7D"></div>

0 commit comments

Comments
 (0)