👉 A group of Axway employees, ex-Axway employees, and some developers from Titanium community have created a legal org and now officially decide all matters related to future of these products.

API FAQ:

↑ Watch video on YouTube ↑

@titanium/review-dialog

Native module that allows you to use the Apple's Store Review Dialog in Axway Titanium native mobile apps. Uses the SKStoreReviewController from iOS 10.3+ in your Titanium application.

📝 Description

This is a repackaging of the compiled iOS module for ti.reviewdialog to allow for installation via npm.

🚀 Getting Started

Install `@titanium/review-dialog` in root of project

npm install @titanium/review-dialog

Sample code

const win = Ti.UI.createWindow({
    backgroundColor: '#fff'
});

const btn = Ti.UI.createButton({
    title: 'Open Review Dialog!'
});

btn.addEventListener('click', function() {
    const ReviewDialog = require('@titanium/review-dialog');
    ReviewDialog.requestReview();
});

win.add(btn);
win.open();

✨Features

Includes Titanium native iOS module: ti.reviewdialog 2.0.0-Beta-1

const dialog = require('@titanium/review-dialog');

Requirements

Titanium Mobile SDK 6.0.0.GA or later
iOS 10.3 or later
Xcode 8.3 or later

Usage

There are some important notes on when to show the rating dialog (thanks to @skypanther:

The internal API itself will decide when, or if, to show the prompt
You should not show it more than once for a given version of your app
You should not show the dialog in response to user actions (like after a user clicks a button)
You should not show it on first app launch (even after an update) but should wait until the user has used your app for a "meaningful" amount.

The following (ES6+ based) example shows how to use it in a real world example. It relies on the semver module / http://gitt.io/component/semver to compare app versions. Apple's own example uses a simple launch count to determine "meaningful" amount of use, which is also used in this example. You should use something appropriate for your app (amount of time, completion of an action N times, etc.):

import semver from 'semver';
import Review from 'ti.reviewdialog';

// first, check that the user has used your app for a "meaningful" amount
// here, a simple count of some action
let countOfSomeUserAction = Ti.App.Properties.getInt('countOfSomeUserAction', 0);
countOfSomeUserAction += 1;

Ti.App.Properties.setInt('countOfSomeUserAction', countOfSomeUserAction);

if (countOfSomeUserAction >= 4) {
  // if they've done whatever action 4 or more times, check the app version
  const lastVersionPromptedForReview = Ti.App.Properties.getString('lastVersionPromptedForReview', '1.0.0');
  let appVersion = Ti.App.version;
  const appVersionAsArray = appVersion.split('.');
  if (appVersionAsArray.length > 3) {
    // the semver library supports max 3-part version numbers (per semver rules)
    appVersion = appVersionAsArray[0] + '.' + appVersionAsArray[1] + '.' + appVersionAsArray[2];
  }
  if (semver.gt(appVersion, lastVersionPromptedForReview)) {
    // if the current app version is greater-than the last time you prompted them
    // prompt them with the titanium-review-dialog alert
    Ti.App.Properties.setString('lastVersionPromptedForReview', appVersion);
      if (Review.isSupported()) {
          Review.requestReview();
      }
  }
}

Hyperloop

This module is also built in Hyperloop to demonstrate the native API access with JavaScript. You can simple require the ti.reviewdialog.js in your application and run it!

Example

Request a new review dialog:

const review = require('@titanium/review-dialog');

if (review.isSupported()) {
    review.requestReview();
}

Methods

isSupported
requestReview

Author

Hans Knoechel (@hansemannnn / Web)

Contributing

Code contributions are greatly appreciated, please submit a new pull request!

📚Learn More

ti.reviewdialog GitHub Repo - Repo for original ti.reviewdialog module

📣 Feedback

Have an idea or a comment? Join in the conversation here!

©️ Legal

License

Apache 2.0

Keywords

FAQs

What is @titanium/review-dialog?

Is @titanium/review-dialog popular?

Is @titanium/review-dialog well maintained?

Last updated on 11 Apr 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@titanium/review-dialog

👇 support for Amplify Cloud and Mobile 👇

🛑 Axway support for Amplify products has ended for most products related to mobile and cloud.

A few of the open-source versions of Axway Amplify products will live on after Axway Amplify End-of-Life (EOL) announcements. However, all closed-source projects and most open-source projects are now dead.

API FAQ: