Applause Android SDK Installation Guide for ANT


Please see: our download page to get the latest Android SDK


Each time your app launches, you should start a new Applause SDK session. The only action to take is to invoke the Applause.startNewSession() method in the onCreate event of your application class.

First, make sure you import the Applause SDK


Then launch the Applause SDK

public class MyApplication extends Application {
    public void onCreate() {
        Applause.startNewSession(this, "Your-Application-Key-Goes-Here");


Make sure to declare Applause SDK activities in the <application> section. The result should look as follows

  <activity android:name="" />
  <activity android:name="" />
  <activity android:name="" />


Appluase SDK requires the android.permission.INTERNET permission to work. Please add following line inside <manifest> tags

<uses-permission android:name="android.permission.INTERNET"/>

Appluase SDK is capable of gathering device state like Bluetooth or Networking. Please check detailed instruction in this section.

For more info

For more information like setting the API key go to the main help page

Pro-actively survey your beta participants for Contextual Feedback

Since the mobile SDKs 3.2.0 it’s now possible to proactively seek feedback from your user base.

For example, if you are testing a new feature you can set up a ‘trip wire’ in the flow to prompt the user for feedback about the new feature. (They don’t need to shake!)

How it works

You can customize the following attributes of the Feedback UI:


The application starts to listen after a successful Applause SDK login. So please make sure any trip wires are laid after you start your Applause session.

The context is expressed in the TAGS parameter, here you can tag your feedback with a context so that in the web panel you know from where in your application the feedback came.


Android Example 

Intent intent = new Intent(context.getPackageName() + "/feedback");
intent.putExtra("TITLE", "Custom Title");
intent.putExtra("HINT", "My custom hint");
intent.putExtra("RATING_TITLE", "Custom Rating title");
String tags[] = new String[]{ "dashboard", "premium_user"};
intent.putExtra("TAGS", tags);


iOS Example

NSDictionary *feedbackSettings = @{

@"TITLE": @"Custom title",
@"RATING_TITLE": @"Custom rating title",
@"HINT": @"My custom hint",
@"TAGS": @[@"tag1", @"tag2", @"tag3"]}; 
[[NSNotificationCenter defaultCenter] postNotificationName:@"APLShowContextualFeedbackNotification" object:nil userInfo:feedbackSettings];

Applause SDK: Android Installation Guide


Want to see the Mobile SDK up and running in a demo project right now? Take a look at our Android Hello World application – available in Github.


First visit the download page to get the latest Applause Android SDK

If you’re not using gradle please see:


Each time your app launches, you should start a new Applause SDK session. The only action to take is to invoke the Applause.startNewSession() method in the onCreate event of your application class.

Please note the ‘withUTestEnabled‘ flag. If you’re using then this has to be set to false. But if you’re using our uTest testing services it should be true.

First, make sure you import the Applause SDK


Then launch the Applause SDK

public class MyApplication extends Application {
    public void onCreate() {
        Configuration configuration = new Configuration.Builder(this)
        Applause.startNewSession(this, configuration);


Note in order for your application logs, bugs and crashes to be reported to your application you have to add the API key within the confiuration.

Go to and in the dashboard or settings of your application you’ll see your app key.



By default the SDK adds the android.permission.INTERNET permission. This is required for SDK to contact the sessions server.

Applause SDK is capable of gathering device state like Bluetooth or Networking. Please check the detailed instructions in this section.

Additional Information

Applause SDK for Android Changelog


  • Hot fix for duplicated Report Dialog

March 1st, 2017


  • Fix for Auto-Instrumentation

February 3rd, 2017


  • Fix for Auto-Instrumentation

September 22nd, 2016


  • Support for Android Nougat
  • Added Portuguese localization
  • When app is sending message to server basic bootstrap info is refreshed
  • Deprecate Market Mode, Contextual Feedback and Quick Login – planned to be removed in next version

September 9th, 2016


  • Unified bug and feedback report attachments
  • Added SDK/application version in settings

July 25th, 2016


  • Surveys

July 7th, 2016


  • Update for AIS: fail gracefully if Android version is not supported

May 30th, 2016


  • Fixed various bugs for offline sessions

April 28th, 2016


  • Import video attachments to bug report from System Gallery

April 18th, 2016


  • Minor fixes in spanish translations
  • New feature: track NFC state
  • New feature: track Audio state
  • Fixes to Bug reporting UI

April 11th, 2016


  • NFC service support
  • less sensitive shake detection

Mar 23rd, 2016

 3.5.0 – March 15th 2016


  • Improved  handling of offline sessions
  • Korean, German, Spanish, and French l10n
  • Less verbose logging of the SDK internals
  • Better bug and feedback attachments handling

3.4.9 – March 7th 2016


Improve screenshot taking for OpenGL views

3.4.8 – March 2nd 2016


  • Data persistence improvements
  • several  small UI fixes
3.4.6 – Feb 23rd  2016  
  • Data persistence improvements
  • small UI fixes
  • fixed crash for some clients
  • Updated mechanism of importing Images to a report
3.4.4 – Feb 15th  2016  
  • DB small refactor
  • Improved startup procedure
  • Bug steps UI improvement (back end only)
3.4.2 – Feb 7th  2016  
  • bug fixes
  • Network optimisations
3.4.0 – January  25th  2016
  • Rebranding of User Interface
3.3.2 – November 25th  2015
  • Bugs fixes for UI issue with capturing screenshots
3.3.0  – November  13th  2015
  • UI update removes the need for the ‘android.permission.SYSTEM_ALERT_WINDOW‘ permission in manifest.
3.2.2 – October  13th  2015
  • Screenshots for Contextual Feedback Added
3.2.0 – September 30th  2015
  • Contextual Feedback Added
3.1.5 –  September  2015
  • Optional Tutorial Dialog
3.1.2 –  September  2015
  • Installation counter bug fixed.
3.1.0  –  August  2015
  • Switch for uploading files only via WiFi
  • Lots of bug fixes and stability improvements
This version is the last one support Android 2.2 and 2.3. Next version will support 4.+ devices.
3.0.0  –  July 2015
  • Screen recording for Android 5+. Create bug reports with video attachments.
2.9.2 –  June 2015
  • Various bug fixes
2.9.1 –  June 2015
  • Import attachments from system gallery
  • Import attachments from camera
  • SDK Tutorial
2.8.3 – May 2015
  • hot fix for dialogs
2.8.2 – May 2015
  • removed passcode from BETA login page
  • stability fixes for notifications and shake to report
  • decreased number of required characters to 1 in report screen
  • anonymous user is shown as Anonymous Tester instead of the e-mail address
2.8.1 – April 2015
  • new bug report view, now you can also provide: title, problem description, steps to reproduce and severity
  • new configuration flag available ‘notificationsEnabled’, setting it to false will hide login and report notification
  • feedback view is enabled by default
  • stability improvements and bug fixes
  • Support for Android 5.1
  • various UI updates and bug fixes
  • login as anonymous is saved in SDK preferences
    setting setDefaultUser(““) trigger login action automatically
  • Feedback view performance fix
  • bug fixes
  • Beta tutorial
  • misc. bug fixes.
  • Beta login dialog better experience
  • Disabled anonymous login for uTest enabled builds
  • Bluetooth, Networking, Telephony reported conditions update. They are more verbose.
  • Added passcode rest (for Mobile Beta Management only)
  • Condition watcher fixes (e.g. battery state, bluetooth state, etc.)
  • Additional bug fixes
  • WithDefaultUser()  automatically chooses user from quick auth
  • Enhanced  user experience during quick auth login
  • Bug fixes
  • Mobile Beta Management compatibility
2.5.3: Pre-Production & Production Release
  • Fixed bug with installation count
  • Fixed problem with reporting issues in airplane mode
  • Tapping on notifcation shows same dialog as shake action
  • Fixed problem with logs filtering
2.5.0: Pre-Production & Production Release
  • New UI for Report Dialog
  • Improved screenshot performance
  • Created fallback actions for ANT projects with incorrectly configured AndroidManifest
  • Android dialogs, Toast and Action Bars  can  now be captured in screenshots


  • Silent Login: Users are automatically authenticated if store credentials are valid
2.4.0: Pre-Production & Production Release
  • Library renamed from ‘applause-sdk-preprod’ to ‘applause-sdk’
  • Crash stack trace contains optional cause
  • Cleaned up notification behavior
  • Sending screenshots with overlays bug fixed
  • Improved quick login list performance
  • Screen density is shown as mdpi/hdpi instead of integer value
New Features:
  • Production environment support re-introduced
2.3.0: Pre-Production Release Only
  • Sped up screenshot workflow, users no longer have to wait to see report view
  • Updates to disabled build user notifications
  • UI update for test cycle dialog
  • Fixed bugged Applause dialog closing behavior
2.2.0: Pre-Production Release Only
  • Improved shake detection on a wider range of mobile devices
  • Added landscape support for in-app bug report dialog
  • Added landscape support for in-app feedback dialog
  • Screenshot editor adapts to display orientation
  • Added UI support tablets
  • Updated  UI font
  • Resolved issues with screenshots on Android 4.0
  • Resolved issue with remembering  username and password (if selected)
  • Resolved a number of crashing issues
2.1.0: Pre-Production Release Only
  • Improved feedback to user regarding login (via Toast messages)
  • Feedback crash fixed
  • Screenshot issue affecting Android 4.1 fixed
  • Report Problem Activity activated on shake, even if app is in background
  • Notification bar spamming issue fixed
2.0.0: Pre-Production Release Only
  • ‘Apphance’ brand has been retired and replaced with ‘Applause SDK’
  • All classes and configurations have been revised.  â€˜apphance’ instances have been replaced by  â€˜applause’
  • Integration with Applause SDK is as easy as possible. Developer has to call only Applause.startNewSession() method. The should not be using: Apphance.onStart() or Apphance.onStop() any more.
  • Additional integration refinements
  • Names in imports have been changed to reflect Apphance to Applause SDK rebrand
  • Session and Crash reporting integration with Applause 360 degree dashboard

New Features:

  • For Maven users: Can merge manifest if <mergeManifests> flag in configuration is set to: true
  • Changes and additions to required and optional permissions
  • startNewSession no longer needs to be an Activity and can be launched from anywhere the context is available

Download >>

1.9.13: Pre-Production + Production Release
March 16, 2014
  • Minor fixes
1.9.6 – Pre-Production Release Only
October 8, 2013


  • Fixed issue with PNG resource (it was a JPG) when using aar.
1.9.5: Pre-Production Release Only
September 12, 2013


  • Fixed issue where notifications were not visible in SILENT mode
  • Fixed crash when integration with uTest was on but no test cycle was available
  • Fixed bug where typing an incorrect password froze the app (typing in a wrong password prevented the user from retrying)
  • Version number sent correctly as 1905 (instead of 195)
1.9.3: Pre-Production Release Only
August 12, 2013

New Features:

  • Introduced an experimental NativeLog util class which can be useful with native code for sending logs and crashes. Details are in the javadoc for the NativeLog class.


  • Eliminated possible deadlock when connection was re-established during logging process
  • Fixed app crash when returing back from certain external Activities (like Camera, GMail, Preferences etc) (NullPointerException in and
  • Improved escaping for invalid JSON characters. For example, in previous versions, logs with certain special characters like “r” prevented the log from being sent to the server (due to malformed JSON)
  • Corrected issue where Apphance forces the login dialog to be in portrait mode. Now users can login using landscape mode as well.


  • The Apphance.startNewSessionNow() method is now deprecated, and users should use startNewSession instead. The behavior is exactly the same. Note that we have not supported or documented startNewSessionNow() in over a year, so most current users should already be using the correct method. This should only impact long-standing Apphance users.
1.9: Pre-Production + Production Release
July 18, 2013

New Features:

Pre-Production Only:

  • New integration approach that replaces instrumentation in the manifest.xml file
  • New onStart and onStop methods for tracking activities (used for capturing screenshots for bug reporting)
  • Spray feature for hiding sensitive information on bug report screenshots
  • Dialogs have replaced activities – e.g. Login is now a dialog displayed on top of the source activity instead of a new activity
  • The bug report editor can be run in a separate process to increase available memory for taking screenshots

Production Only:

  • New onStart and onStop dummy methods for compatibility with the pre-production library


Pre-Production Only:

  • Apphance runs smoothly with the Eclipse debugger

Production Only:

  • Minor bug fixes and improvements
1.8.3: Pre-Production Release Only
February 20, 2013


  • Fixed a crash issue when uTest integration was enabled on the device side but not on the server side.
  • Fixed a crash issue when the Android device does not expose the fdisk linux tool (used for collecting device info at startup).
  • Fixed an issue where the app froze with improperly implemented splash screens.
1.8.2: Pre-Production + Production Release
January 24, 2013


  • Minor bug fixes
1.8.1: Pre-Production Release Only
December 6, 2012


  • Fixed issue with using the killswitch feature while the library is in silent mode.
1.8: Pre-Production + Production Release
November 30, 2012

New Features:

Pre-Production Only:

  • Added kill-switch feature to the pre-production SDK
  • CPU + Memory optimization of the login screen activity – the quick login window might have loaded user avatar images multiple times.

Production Only:

  • Added feedback feature to the production SDK
1.7.2: Pre-Production Release Only
October 30, 2012


  • Stability Improvements
1.7.1: Pre-Production + Production Release
October 17, 2012


  • Apphance no longer crashes the app on the GT-P6810 device
  • No race condition while gathering device info: Concurrent modification exception
  • Apphance does not cause a java.lang.ArrayIndexOutOfBoundsException -> length=12; index=-1 exception when the user locks the screen on the problem reporting screen
  • Apphance should no longer detach itself from the app (user could no longer send a problem report)


  • Major login activity optimizations
1.7: Pre-Production + Production Release
September 12, 2012


  • Apphance works correctly when an application receives system intents (sending an SMS, etc.)
  • Lots of stability fixes
1.0: Pre-Production + Production Release
August 15, 2012

Initial version of the Android pre-production library.

How to get the Applause Android SDK

The Applause Android SDK works in both production and pre-production is now at version 3.9.2

We offer three methods of integration

Gradle (recommended integration method)

Add the following dependency in your application’s build.gradle file

compile 'com.applause:applause-sdk:3.9.2@aar'


In order to use Applause SDK in projects using Android Maven Plugin, you will need to modify your application’s pom.xml file.



In order to use Applause SDK in projects using Ant you need to download the latest zip file.

Unpack the archive. It contains standalone Eclipse project based on Ant build system. We advice to add this line in your application’s file


This will tell both command line interface and Eclipse builder that you application depends on Applause SDK.

Note: If your application has already other dependencies please replace ‘1’ number with the next continuous integer.



You can review  our changelog to see what’s updates we’ve been rolling out.

Applause SDK for iOS Changelog

Applause SDK for iOS Changelog


April 14, 2017

  • removed build setting which informed that embedded content contains Swift
  • removed Logger.swift — to avoid Swift compatiblity issues



November 17th, 2016

  • support for swift 3.0.1


October 11, 2016

  • fixes crash on iOS 8 on Simulator when logs from simulator were disabled
  • fixes crashes related to location reporting when session was not started
  • improved documentation in code
  • added view controller’s title to custom condition



October 3, 2016

  • compiled with iOS SDK 10 and Swift 2.3, (if you use Swift 3, please use plain 3.10.0 version)
  • special version of 3.10.0 to support Swift 2.3 apps



September 29, 2016

  • compiled with iOS SDK 10 and Swift 3, (3.9.0 is the last version which supports Swift 2.2)
  • deprecated contextual feedback
  • deprecated option to enable Mach Exceptions
  • deprecated Objective-C category APLSwiftLoggingSupport




September 9, 2016

  • added Portuguese localization
  • support for first version of Applause watchOS SDK
  • marked SKD Mode as deprecated – planned to be removed in next version
  • when app is coming from background basic bootstrap info is refreshed
  • bug fixes and stability improvements



June 1, 2016

  • unified bug and feedback report
  • added SDK/application version in settings
  •  bug fixes and stability improvements



July 4, 2016

  • added in-app surveys
  • updated database model to V6



April 18, 2016

  • dropped support for iOS 7
  • updated framework from static library framework to dynamically linked embedded framework
  • added Swift Logger class
  • inform user about server maintenance
  • numerous refactors and clean ups
  • bug fixes


March 31st, 2016


  • Partial Xamarin implemenation to support future capabilities when productized.


February 29, 2016


  • localised strings consolidation with Android SDK
  • added localisation for: German, French, Spanish and Korean
  • added support for boostrap quality parameters (video and images)
  • UX improvements for login and bug report screens
  • improved UI for BETA login screen
  • numerous bug fixes and stability improvements
  • refactored screen recorder – added tests for it
  • Updated database model to V5



Feb 22nd, 2016

  • UI bug fixes



Feb 15th, 2016

  • numerous bug fixes and stability improvements
  • enabled MBM for MQA
  • minor UI adjustments
  • resolve issue with build warnings on Xcode 7
  • Updated database model to V4


Jan 22, 2016


  • Updated database model to V3
  • dropped support for iOS 6 (last SDK supporting iOS 6 is 3.2.5)
  • new SDK Peregrine UI
  • extracted CoreSDK
  • strings localization for Spanish – Hola! Que Tal!
  • data which was synced is removed from local data base
  • enabled MBM for MQA (with a support for both QA and Market modes)
  • numerous bug fixes and stability improvements


December 8, 2015


  • fixes crash related to CoreData when packet was saved


November 24, 2015


  • fixes issue with double login page


October 22, 2015


  • added Screen Recording feature for MQA library


October 22, 2015


  • changes default value of “Upload attachments only via WiFi” setting


October 8, 2015


  • fixes issue with dylib – session logs were not sent after AIS
  • fixes bug with production feedback on MQA
  • fixes crash with contextual feedback
  • resolves minor UI glitches


September 16, 2015


WARNING: This version has breaking bug which prevents from sedning messages when app was auto-instrumented.

  • adjustments for iOS SDK 9 (toast, interface rotations)
  • library supports Bitcode
  • this version requires Xcode 7 to compile due to the bitcode support
  • user can now pick videos when adding attachments
  • improved handling of not sufficient permission to access photo library and camera


September 7, 2015


  • added option to disable tutorial
  • added tappable version label on login screen (toggles between app and SDK version)
  • contextual feedback, triggered by notification
  • introduced database migration mechanism
  • support for upload API V1
  • bug fixes and stability improvements


September 2, 2015


  • fixes issue when serverURL was not set, no messages were pushed to backend server


August 26, 2015


  • added Screen Recording feature
  • reworked from ground up the internals of how SDK is storing data, for persistence we now use CoreData framework based on SQLite, rather than text files
  • dropped support for iOS 5



June 18, 2015

  • added support for Cordova Plugin
  • enabled tutorial for MQA
  • enabled structured bug report for MQA
  • adjusted color scheme for bug and feedback screens for both MQA and Applause SDK
  • removed 10 character limit for bug and feedback description
  • improved wording in error toast in bug report



May 12, 2015

  • removed passcode from BETA login page
  • fixes bug with two initial screenshot attachments in bug report
  • fixes bug with missing option to open tutorial screen from report type choser



May 7, 2015

  • new structured bug report
  • improvements to the splash screen message view
  • fixed bug with disappearing report screen presented quickly after auto-login
  • fixed bug that forget passcode screen can be accessed from tutorial
  • making sure that only one session can be started during app lifetime
  • improvements around failed login requests



April 30, 2015

  • fixed issue that reported bugs are not going to test cycle



March 18, 2015

  • fixed bug with screenshots of tiled views
  • fixed bug with broken support of reportOnShakeEnabled flag
  • migrated Applause data from Documents directory
  • fixes for BETA tutorial
  • minor cleanups of the SDK code
  • MQALogger has old and un-deprecated production feedback methods


2.2.1: Welcom Screen & Tutorial

March 6, 2015

  • introduced rich text for Welcome message
  • added tutorial for BETA
  • bug fixes and stability improvements



February 18, 2015

  • merged pre-prod and production sdk’s into a single sdk (to rule them all)


2.1.4: Pre-Production and Production Release

January 14,2015

New Features:

  • Improved “forgot password” flow


  • When device is offline, error message will return “Connection failed” instead of “No connection”.
  • Fixed popup issue on iPad 2s running iOS 8.1.2
  • Fixed failing test issue in APLUsersIdentifyServiceSpec
  • Fixed crash when CLLocationManagerDelegate is destroyed in callback
  • Will no longer display ‘Forgot passcode’ when endpoint to reset is not provided


2.1.3: Pre-Production and Production Release

January 7, 2015


  • Assorted bug and crashing fixes
  • Fixed Feedback layout on 3.5″ screens under iOS 6
  • Fixed keyboard display overlap issue on iPhone 4 running iOS 6.1.3
  • Uploaded .zip frameworks on S3 are now defined as public artifacts.


2.1.2: Pre-Production and Production Release

December 8, 2014

New Features:

  • Introduced Product environment support


  • Improved in-app bug and feedback reporting workflow
  • Fixed horizontal display orientation issue
  • Fixed in-app splash page layout issue


2.0.2: Pre-Production Release Only

April 28, 2014


  • Release candidate for Apphance -> Applause SDK


1.9.0: Pre-Production + Production Release

November 19, 2013

New Features:

  • New support for 64 bit ARMv8 architectures


  • New PLCrashReporter

Pre-Prod Only:

  • Improved screenshot mechanism


  • Included features for upcoming merge of pre-production and production libraries


1.8.20: Pre-Production + Production Release

October 30, 2013 Fixes:

Pre-Prod Only:

  • Fixed issue reporting screenshots in certain cases

Prod Only:

  • Minor bug fixes


1.8.18: Pre-Production + Production Release

October 8, 2013 Fixes:

Pre-Prod Only:

  • Fixed freeze during test cycle selection

Prod Only:

  • Minor bug fixes


1.8.17: Pre-Production + Production Release

September 23, 2013 New Features:

  • The Apphance pre-production library now requires the AssetLibrary framework Apphance now supports attaching screenshots to bug reports from the user’s photo library. This is useful in cases where Apphance is unable to take a screenshot, but the user can still do so using iOS’s screenshot functionality. See the Stating a Session document for more information.


1.8.12: Production Release Only

September 23, 2013 Fixes:

  • Minor bug fixes


1.8.11: Pre-Production + Production Release

August 2, 2013


  • Minor grammatical bugs and issues

Pre-Production Only:

  • Fix for multi touch problem when double-slide bug reporting is enabled
  • Added showReportScreen method to APHLogger

Production Only:

Minor Updates:


1.8.8: Pre-Production + Production Release

April 11, 2013 Fixes:

Pre-Production Only:

  • Fixed focus issue with dialogs that occurred in rare circumstances

Production Only:

  • Fixed logging issue where some logs were ignored
  • Fixed issue where logs were being recorded for all users instead of with special events, like crashes

New Features:

Pre-Production Only:

  • Added spray feature for covering sensitive data in bug report screenshots
  • Added an alternative way to report bugs without shaking the device (double finger slide)

API Update:

  • Changed the API start session method to be more compatible with the Production library. Older code will still work, but developers should update to the newer syntax.

The previous versions used the following syntax:

[APHLogger startNewSessionWithApplicationKey:@"Your-Apphance-Application-Key-Goes-Here" apphanceMode:kAPHApphanceModeQA withUtest:false];

The new version removes the additional options from startNewSessionWithApplicationKey and separates them into different settings values. Now startNewSessionWithApplicationKey takes your API key as its only option.

More information about thew new syntax can be found on the Starting a Session page.


1.8.2: Pre-Production + Production Release

January 24, 2013


  • Removed client side requirement for the CFBundleVersionFormat.


  • Fixed focusing problem with uitextfiels after Apphance returns from the problem reporting screen.


1.8.1: Pre-Production Release Only

December 6, 2012 Fixes:

– Fixed issue with using the killswitch feature while the library is in silent mode.


1.8: Pre-Production + Production Release

November 30, 2012

New Features:

  • Added kill-switch feature to the pre-production SDK
  • More detailed crash reports
  • Extended details for crash reasons. For example: -[__NSCFDictionary setObject:forKey:]: attempt to insert nil value (key: MT-User-Id)
  • Stacktraces for all device threads


  • Resolved namespacing bug for the JSON library


1.7.1: Pre-Production + Production Release

October 15, 2012

New Features:

  • Data sent, Data received device statistics are sent to the server (allows devs to investigate 3G/WiFi data usage).


  • Fixed issue with OpenGL screenshots. In rare cases hybrid views mixing OpenGL and UIView caused invalid screenshots to be made
  • The login with default credentials toast changes the orientation along with the device.


1.7: Pre-Production + Production Release

September 19, 2012

Initial version of the iOS ARMv7 pre-production library.

New Features:

  • Support for non integer CFBundleVersions Fixes:
  • Improves support for iOS6


Applause SDK Installation Guide for iOS

NOTE: Starting from 3.10.0 applications must be compiled with Xcode 8, using Swift 3; the last framework version which supports Swift 2.2 is 3.9.0

ALSO please note if you wish to use Swift 2.3 with 3.10.0 then please choose 3.10.0-swift2.3

Please check the iOS SDK migration guidelines if you are updating your SDK from an earlier version

CocoaPods Installation Guide

We strongly recommend this type of integration. To integrate Applause SDK using CocoaPods, add this line to your Podfile:

pod 'Applause-SDK', '~&gt; 3.11.0' # for Swift 3.1
pod 'Applause-SDK', '3.10.0-swift2.3' # for Swift 2.3

You may have to update your cocoapod repo to see all versions of the Applause SDK:

pod repo update

Or, you can check the cocoapod website:

Since Applause framework uses Swift you need to use use_frameworks! flag in your Podfile.

For installing CocoaPods, check the guide at:

Manual Integration

Step 1 – Download the Applause Sdk

Start by downloading the latest version of the Applause iOS SDK (v3.11.0, ZIP)

If you want to go with Swift 2.3 please use Applause iOS SDK (v3.10.0-swift2.3, ZIP)

Step 2 – Add Applause to Your Project

Do this by dragging and dropping the Applause.framework folder you downloaded onto the “Frameworks” folder in your Xcode Project Navigator. The Applause framework should now be visible in Xcode just like any other framework (like the UIKit.framework, for instance).

Step 3 – Add Applause to Embedded Frameworks

In project settings (clicking on your project in the Project Navigator), select your target, and then choose “General” tab. Add Applause.framework to the “Embedded Binaries” by clicking a +.

Step 4 – Enabling Swift code

Since SDK 3.6.0 our SDK contains Swift code and so if you’re already using Xcode 8 it is necessary to enable ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES in your project. For Xcode 7 the flag you need to enable is EMBEDDED_CONTENT_CONTAINS_SWIFT (more details can be found here)

Step 5 – Set Linker Flags

Add the following flags to OTHER_LINKER_FLAGS in your project configuration for both Debug and Release modes: -ObjC

You can find this setting by clicking on your project in the Project Navigator, choosing “Build Settings”, and search for OTHER_LINKER_FLAGS.

Step 6 – Import Applause Module


Import Applause module using:

@import Applause;

in a file in which you want to use Applause SDK.


To use Applause SDK in Swift class, simply import it with:

import Applause

at the beginning of your Swift class file.

Starting Applause SDK

At this point your project should be properly configured to used Applause SDK. The last thing that needs to be done is to start sessions. For that you need to copy your API Key for the Application Settings.

  • QA Mode: extended device condition logging, UI for logging in and reporting problems – (it’s default mode)
  • Market Mode: headless mode, with limited logging, only crashes are reported (MARKET MODE has been deprecated and will be removed in future versions)

Check the advanced configuration settings document to learn how change mode.


To start sessions in Objective-C projects add the following call to your AppDelegate.m (should be at the beginning of the didFinishLaunchingWithOptions: method):

#import "AppDelegate.h"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[APLLogger startNewSessionWithApplicationKey:@"Paste Your API Key Here"];
return YES;



To start sessions in Swift projects add the following call to your AppDelegate.swift (should be at the beginning of the didFinishLaunchingWithOptions: method):

import UIKit

class AppDelegate: UIResponder, UIApplicationDelegate {

var window: UIWindow?

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -&gt; Bool {
APLLogger.startNewSession(withApplicationKey: "Paste Your API Key Here")
return true



Replace all instances of NSLog with APLLog to send logs to the Applause server in addition of logging to console:

APLLog(@”This is test log with object %@”, object);


In Swift, use the log method on object of Applause type:

APLLogger.log("This is a default info log with object \(object)")
APLLogger.log(This is a warning log with object \(object)", with: APLLogLevelWarning)

To learn more about logging events using Applause, see the Logging Methods documentation.

Crash Reporting

Applause handles uncaught exceptions from your application and sends revelant information to the Applause server.

If you are deploying a build to the App Store, or you’ve removed the symbols from your build, you will also need to upload a special symbols file to Applause so that it can symbolicate your crashes. You can find more info at Symbolication help article.

Advanced Configuration Settings

For advanced configuration settings, please see this document.

Applause SDK Pre-Production Installation Guide for Android (Maven)


Please visit our download page to get the latest Applause Android SDK.


Each time your app launches, you should start a new Applause SDK session. The only action to take is to invoke the Applause.startNewSession() method in the onCreate event of your application class.

First, make sure you import the Applause SDK


Then launch the Applause SDK

public class MyApplication extends Application {
    public void onCreate() {
        Applause.startNewSession(this, "Your-Application-Key-Goes-Here");


The easiest way to have correct AndroidManifest.xml file is to allow Maven Plugin to do the merging. Go to plugin declaration and set <mergeManifests> to true. As the result it should look as follows

    <!-- add the following mergeManifests option -->

If you don’t want to use the extention please add following activities to <application> section. The result should look as follows

  <activity android:name="" />
  <activity android:name="" />
  <activity android:name="" />


Appluase SDK requires the android.permission.INTERNET permission to work. If you already set the <mergeManifests> to true there is further action required. Otherwise please add following line inside <manifest> tags

<uses-permission android:name="android.permission.INTERNET"/>

For more info

For more information like setting the API key go to the main help page