A utility that reminds your iPhone app's users to review the app.
Objective-C
Latest commit 6a6ed03 Feb 12, 2016 @arashpayan Merge pull request #238 from ReadmeCritic/master
Correct the spelling of CocoaPods in README
Permalink
Failed to load latest commit information.
ar.lproj Added Arabic localization Nov 23, 2013
ca.lproj - Catalan localization Oct 14, 2012
cs.lproj fixed Czech again (last one, I promise :)) Oct 27, 2012
da.lproj Don't clobber an app's existing Localizable.strings files. Sep 7, 2012
de.lproj Minor change in capitalisation (german) May 25, 2013
el.lproj Greek localization Jan 31, 2013
en.lproj Changed capitalisation to keep consistency May 24, 2013
es.lproj Most friendly messages in spanish Jun 15, 2015
fi.lproj Converted Finnish and Norwegian localizations to UTF-8 Nov 14, 2012
fr.lproj Multiple corrections in french translation May 25, 2013
he.lproj Hebrew localization compliments of Ron Grosberg Nov 11, 2012
hu.lproj Hungarian localization Nov 21, 2012
id.lproj Add Indonesia translation Jun 3, 2013
it.lproj more minor changes to italian localization Nov 27, 2013
ja.lproj Used better Japanese translations. Jun 3, 2015
ko.lproj Don't clobber an app's existing Localizable.strings files. Sep 7, 2012
ms.lproj Added Malay localization courtesy of translator colleague Nov 6, 2013
nb.lproj Minor translation fix (Norwegian) May 6, 2013
nl.lproj Don't clobber an app's existing Localizable.strings files. Sep 7, 2012
pl.lproj - Catalan localization Oct 14, 2012
pt-BR.lproj Added Brazilian Portuguese localization courtesy of translator colleague Nov 6, 2013
pt.lproj Don't clobber an app's existing Localizable.strings files. Sep 7, 2012
ro.lproj Romanian translation Feb 28, 2013
ru.lproj Added missing comma to Russian localization Nov 6, 2013
sk.lproj Slovak translation added. Oct 11, 2012
sv.lproj Improved Swedish localization courtesy of translator colleague Nov 6, 2013
th.lproj Added Thai localization courtesy of translator colleague Nov 6, 2013
tr.lproj Turkish localization, compliments of Olivier Carruezco Feb 1, 2013
uk.lproj Corrected Ukrainian locale. Feb 26, 2014
vi.lproj Missing semicolon in Vietnamese localization Nov 11, 2013
zh-Hans.lproj Don't clobber an app's existing Localizable.strings files. Sep 7, 2012
zh-Hant.lproj Don't clobber an app's existing Localizable.strings files. Sep 7, 2012
.gitignore Add .gitignore Aug 31, 2012
Appirater.h Fall back to bundle name if bundle display name is null Apr 6, 2015
Appirater.m implemented delegate method to opt out from showing the alert view an… Sep 25, 2015
Appirater.podspec.json Update email in podspec Oct 1, 2015
AppiraterDelegate.h implemented delegate method to opt out from showing the alert view an… Sep 25, 2015
CHANGELOG.md Updated CHANGELOG and README Sep 26, 2014
README.md Correct the spelling of CocoaPods in README Feb 10, 2016

README.md

Introduction

Appirater is a class that you can drop into any iPhone app (iOS 4.0 or later) that will help remind your users to review your app on the App Store. The code is released under the MIT/X11, so feel free to modify and share your changes with the world. Read on below for how to get started. If you need any help using, the library check out the Appirater group.

Getting Started

CocoaPods

If you're new to CocoaPods watch this. To add Appirater to your app, add pod "Appirater" to your Podfile.

CocoaPods support is still experimental, and might not work in all use cases. If you experience problems, open an issue and install via Git submodule

Manually

  1. Add the Appirater code into your project.
  2. If your project doesn't use ARC, add the -fobjc-arc compiler flag to Appirater.m in your target's Build Phases » Compile Sources section.
  3. Add the CFNetwork, SystemConfiguration, and StoreKit frameworks to your project. Be sure to change Required to Optional for StoreKit in your target's Build Phases » Link Binary with Libraries section.

Configuration

  1. Appirater provides class methods to configure its behavior. See Appirater.h for more information.
[Appirater setAppId:@"552035781"];
[Appirater setDaysUntilPrompt:1];
[Appirater setUsesUntilPrompt:10];
[Appirater setSignificantEventsUntilPrompt:-1];
[Appirater setTimeBeforeReminding:2];
[Appirater setDebug:YES];
  1. Call [Appirater setAppId:@"yourAppId"] with the app id provided by Apple. A good place to do this is at the beginning of your app delegate's application:didFinishLaunchingWithOptions: method.
  2. Call [Appirater appLaunched:YES] at the end of your app delegate's application:didFinishLaunchingWithOptions: method.
  3. Call [Appirater appEnteredForeground:YES] in your app delegate's applicationWillEnterForeground: method.
  4. (OPTIONAL) Call [Appirater userDidSignificantEvent:YES] when the user does something 'significant' in the app.

Development

Setting [Appirater setDebug:YES] will ensure that the rating request is shown each time the app is launched.

Production

Make sure you set [Appirater setDebug:NO] to ensure the request is not shown every time the app is launched. Also make sure that each of these components are set in the application:didFinishLaunchingWithOptions: method.

This example states that the rating request is only shown when the app has been launched 5 times and after 7 days.

[Appirater setAppId:@"770699556"];
[Appirater setDaysUntilPrompt:7];
[Appirater setUsesUntilPrompt:5];
[Appirater setSignificantEventsUntilPrompt:-1];
[Appirater setTimeBeforeReminding:2];
[Appirater setDebug:NO];
[Appirater appLaunched:YES];

If you wanted to show the request after 5 days only you can set the following:

[Appirater setAppId:@"770699556"];
[Appirater setDaysUntilPrompt:5];
[Appirater setUsesUntilPrompt:0];
[Appirater setSignificantEventsUntilPrompt:-1];
[Appirater setTimeBeforeReminding:2];
[Appirater setDebug:NO];
[Appirater appLaunched:YES];

Help and Support Group

Requests for help, questions about usage, suggestions and other relevant topics should be posted at the Appirater group. As much as I'd like to help everyone who emails me, I can't respond to private emails, but I'll respond to posts on the group where others can benefit from the Q&As.

License

Copyright 2014. Arash Payan. This library is distributed under the terms of the MIT/X11.

While not required, I greatly encourage and appreciate any improvements that you make to this library be contributed back for the benefit of all who use Appirater.

Ports for other SDKs

A few people have ported Appirater to other SDKs. The ports are listed here in hopes that they may assist developers of those SDKs. I don't know how closesly (if at all) they track the Objective-C version of Appirater. If you need support for any of the libraries, please contact the maintainer of the port.

  • MonoTouch Port (using C#). Github
  • MonoTouch Binding (using native Appirater). Github
  • Corona SDK. Github
  • Titanium SDK. Github