Request App Review Functions

This API retrieves the information required to launch the in-app review flow for an app. You must invoke this API before you invoke the voltmx.application.requestReview(config) API.

Before you raise a request for an in-app review, Android recommends that you cache the review object in advance. This is to ensure that the review information is successfully retrieved before the user navigates to a different screen. In addition, you can find the staleness of a cached object from the value of the timeElapsed parameter.

Note:

• Ensure that you add the supportGooglePlayCoreLib=true entry in the androidbuild.properties file of the project.
• In-app reviews only work on devices that have the Google Play store installed, and use Chrome OS or Android versions 5.0 (API level 21), and later

Syntax

voltmx.application.requestReviewFlow(config);

Input Parameters

config - A JSON Object that contains the following keys:

Example

requestReviewFlow: function() {  
    var config = {  
        "clearCachedRequest": false,  
        "onResult":this.requestReviewFlowCallback  
    }  
    voltmx.application.requestReviewFlow(config);  
},  
requestReviewFlowCallback: function(info) {  
    if(info.statusCode == voltmx.application.REVIEW_FLOW_SUCCESS){  
      var timeElapsed = info.timeElapsed;  
      alert("StatusCode: "+ info.statusCode +   
            ",timeElapsed: " + timeElapsed);  
    }else{  
      alert("StatusCode: "+ info.statusCode);  
    }  
}

Return Values

None

Status Code Constants

Remarks

If the GMS or library is missing, the API returns the REVIEW_LIBRARY_MISSING, GMS_LIBRARY_MISSING, or GOOGLE_PLAY_SERVICES_UNAVAILABLE constants. Ideally, when you encounter these errors, you must not invoke the voltmx.application.requestReview(config) API.

Platform Availability

Android

This function requests users to provide a rating and to write a review for an app.

Syntax

voltmx.application.requestReview(config);

Input Parameters

config [optional]- If you want to enable the in-app review feature on Android devices, you must include the config parameter, which is a JSON Object that contains the following keys:

Note: Support for the config parameter (that provides the in-app review functionality) is only available on the Android platform.

Example

requestReview: function() {  
    var config = {  
        "reviewInApp": true,  
        "onResult": this.requestReviewCallback  
    };  
    voltmx.application.requestReview(config);  
},  
requestReviewCallback: function(info) {  
    if(info.statusCode == voltmx.application.REVIEW_FAILED){  
        var timeElapsed = info.timeElapsed;  
        alert("StatusCode: "+ info.statusCode +   
              ",timeElapsed: " + timeElapsed);  
    }else{  
        alert("StatusCode: "+ info.statusCode);  
    }  
}

Return Values

None

Remarks

• If this API returns the REVIEW_SUCCESS status code constant, the review info object is cleared.
• If the GMS or library is missing, the API returns the REVIEW_LIBRARY_MISSING or GOOGLE_PLAY_SERVICES_UNAVAILABLE or GMS_LIBRARY_MISSING statusCode. However, in this case, the API reverts to invoking the older review flow.
  Ideally, you must not invoke this API if you catch these errors in the voltmx.application.requestReviewFlow API.

Status Codes

Platform Availability

• Android
• iOS

Status Codes