Skip to content

Commit 039ff2d

Browse files
MinaSamir11MinaSamir11
authored
Update README.md
1 parent 1c3c52d commit 039ff2d

File tree

1 file changed

+70
-6
lines changed

1 file changed

+70
-6
lines changed

‎README.md‎

Lines changed: 70 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,19 @@ react native in app review, to rate on Play store, App Store, Generally, the in-
2828
[![Paypal](https://www.paypalobjects.com/webstatic/mktg/Logo/pp-logo-100px.png)](https://paypal.me/MinaSamir111)
2929

3030

31-
# Android, iOS platform.
31+
# iOS, android platform.
32+
33+
# System Rating App Store API
34+
35+
[![N|Solid](https://developer.apple.com/design/human-interface-guidelines/ios/images/AppRating_2x.png)](https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/ratings-and-reviews/#system-rating-and-review-prompts)
3236

3337
# Google Play In-App Review API
3438

3539
[![N|Solid](https://developer.android.com/images/google/play/in-app-review/iar-flow.jpg)](https://developer.android.com/guide/playcore/in-app-review)
3640

37-
# System Rating App Store API
41+
# Huawei App Gallery In-App Comment API
3842

39-
[![N|Solid](https://developer.apple.com/design/human-interface-guidelines/ios/images/AppRating_2x.png)](https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/ratings-and-reviews/#system-rating-and-review-prompts)
43+
[![N|Solid](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtyPub/011/111/111/0000000000011111111.20210930165217.85977721887109915940441030648773:50520929085414:2800:4622AF71C3311CECF3522B63A6E74D32F51C64886F111B8580149E78F111D88E.png?needInitFileName=true?needInitFileName=true)](https://developer.huawei.com/consumer/en/doc/development/AppGallery-connect-Guides/agc-comments-introduction-0000001063018306)
4044

4145
# Getting Started
4246

@@ -193,9 +197,33 @@ InAppReview.RequestInAppReview()
193197
// Check table for errors and code number that can return in catch.
194198
console.log(error);
195199
});
200+
196201
```
197202

198-
# Error could happen and code number
203+
# Huawei In-App Comment (App Gallery Review)
204+
205+
Before You Start
206+
- First of all, you must integrate HMS into the project. I am not going to explain these steps You can check [this article](https://medium.com/huawei-developers/android-integrating-your-apps-with-huawei-hms-core-1f1e2a090e98).
207+
- You have released your app officially on AppGallery.
208+
- Users have installed AppGallery 11.3.2.302 or later and signed in using HUAWEI IDs.
209+
210+
211+
```javascript
212+
// trigger UI in app comment to request review for App Gallery;
213+
InAppReview.requestInAppCommentAppGallery()
214+
.then((resultCode) => {
215+
// when return resultCode (102,103) in android it means Rating submitted or Comment submitted
216+
console.log('in app comment app gallery', resultCode);
217+
})
218+
.catch((error) => {
219+
//we continue our app flow.
220+
// we have some error could happen while lanuching in app comment,
221+
// Check table for errors appears in app gallery and code number that can return in catch.
222+
console.log(error);
223+
});
224+
225+
```
226+
# Error could happen and code number (Google play, App Store) Table
199227

200228
| Error Name | Code Number | Description | iOS | Android |
201229
| ----------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------- |
@@ -204,10 +232,28 @@ InAppReview.RequestInAppReview()
204232
| [DYNAMIC ERROR NAME] | 23 | Unexpected error occur may return different error from different user and device check code number to get discovered errors messages that could be happen. | ❌ | ✅ |
205233
| ACTIVITY_DOESN'T_EXIST | 24 | Unexpected error occur while getting activity | ❌ | ✅ |
206234
| SCENE_DOESN'T_EXIST | 25 | Unexpected error occur while getting scene | ✅ | ❌ |
235+
236+
237+
# Error could happen and code number (App Gallery) Table
238+
239+
| Error Name | Code Number | Description | Android |
240+
| ----------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
241+
| ACTIVITY_DOESN'T_EXIST | 24 | Unexpected error occur while getting activity | ✅ |
242+
| Ensure that your app has been correctly released on AppGallery | 101 | Ensure that your app has been correctly released on AppGallery | ✅ |
243+
| check the HUAWEI ID sign-in status | 104 | check the HUAWEI ID sign-in status | ✅ |
244+
| The user does not meet the conditions for displaying the comment pop-up | 105 | The user does not meet the conditions for displaying the comment pop-up | ✅ |
245+
| The commenting function is disabled | 106 | The commenting function is disabled | ✅ |
246+
| The in-app commenting service is not supported. (Apps released in the Chinese mainland do not support this service.) | 107 | The in-app commenting service is not supported. (Apps released in the Chinese mainland do not support this service.) | ✅ |
247+
| The user canceled the comment. | 108 | The user canceled the comment. | ✅ |
248+
| in app comment Unknown error | 0 | Unknown Error | ✅ |
249+
250+
251+
252+
207253

208254
# + Android guidlelines and notes:
209255

210-
# Read very well:
256+
# Read very well for (Google Play):
211257

212258
After publishing you app to test your integration in production or either internal test tracks or internal app sharing and prompt in app review flow you may face issue that not showing review popup after you followed all guidelines very well,
213259
**Note that this issue was classified as google play api issue.**
@@ -244,8 +290,13 @@ In-app reviews only work on the following devices:
244290
# Please Note, To test your integration using the Google Play Store
245291

246292
- In-app reviews require your app to be published in Play Store. However, you can test your integration without publishing your app to production using either internal test tracks or internal app sharing.
293+
294+
# Please Note, To test your integration using the App Gallery Store
295+
- If your app has been released on AppGallery, you need to release an open testing version for it and then perform the testing.
296+
- If your app has not been released on AppGallery, you need to release an open testing version for it and then perform the testing. Otherwise, app authentication will fail.
247297

248-
# Troubleshooting:
298+
299+
# Troubleshooting (Google Play):
249300

250301
As you integrate and test in-app reviews, you might run into some issues. The following table outlines the most common issues that can prevent the in-app review dialog from displaying in your app:
251302

@@ -259,6 +310,19 @@ As you integrate and test in-app reviews, you might run into some issues. The fo
259310
| The quota has been reached. | Use an internal test track or internal app sharing. |
260311
| There is an issue with the Google Play Store or Google Play Services on the device. | This commonly occurs when the Play Store was sideloaded onto the device. Use a different device that has a valid version of the Play Store and Google Play Services. |
261312

313+
---
314+
315+
# Troubleshooting (App Gallery):
316+
317+
Device Restrictions
318+
- Users must have installed AppGallery 11.3.2.302 or later.
319+
- Users must have installed HMS Core (APK) on their devices.
320+
321+
| Application Restrictions | Restrictions |
322+
| ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
323+
| Applicable scope | The in-app comments function is available only for apps released on AppGallery outside the Chinese mainland. |
324+
| Audiences | - The in-app comment pop-up is displayed only for users who have signed in to AppGallery using HUAWEI IDs. <br/> - The in-app comment pop-up is displayed only for users who have opened your app for 10 or more times within the last three months since you have called the in-app comments API <br/> - If the user has submitted a rating and a comment for the current app version, the in-app comment pop-up will not be displayed for the user in this app version. The in-app comment pop-up will be displayed again only after the user updates the app to a later version, has not submitted a rating and a comment for more than a calendar year, and the preceding conditions for displaying the pop-up are met. <br/> - If a user chooses not to receive any app comment notifications under Me > Settings on AppGallery, the pop-up will not be displayed for the user. |
325+
262326
---
263327

264328
# + iOS Notes:

0 commit comments

Comments
 (0)