|
| 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> |
0 commit comments