Skip to content

Latest commit

 

History

History
136 lines (89 loc) · 4.28 KB

README.md

File metadata and controls

136 lines (89 loc) · 4.28 KB
Raw

Air Native Extension for Crashlytics (iOS + Android)

This is an Air native extension for Crashlytics SDK on iOS and Android. It has been developed by FreshPlanet and is used in the game SongPop.

Installation

The ANE binary (AirCrashlytics.ane) is located in the bin folder. You should add it to your application project's Build Path and make sure to package it with your app (more information here).

Before you try to use this ANE, you should first complete the Crashlytics native workflow (iOS or Android) on a test project in order to get your API key. It is linked to your organization and is the same for all your apps, so you only need to do it once.

You will then need to add your API key in your application descriptor twice, once for iOS, once for Android:

  • iOS:
<iPhone>
    
    <InfoAdditions><![CDATA[

       <key>Fabric</key>
       <dict>
         <key>APIKey</key>
         <string>YOUR-API-KEY</string>
         <key>Kits</key>
         <array>
           <dict>
             <key>KitInfo</key>
             <dict/>
             <key>KitName</key>
             <string>Crashlytics</string>
           </dict>
         </array>
       </dict>

    ]]></InfoAdditions>

</iPhone>
  • On Android (note the INTERNET permission and the crashActivity declaration as well):
<android>
    <manifestAdditions><![CDATA[
        <manifest android:installLocation="auto">
            
            ...

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

            <application>

                ...
                
                <meta-data android:name="io.fabric.ApiKey" android:value="YOUR_API_KEY"/>

                ...

                <activity android:name="com.freshplanet.ane.AirCrashlytics.activities.CrashActivity" />

            </application>

        </manifest>
    ]]></manifestAdditions>
</android>

Usage

// Start Crashlytics
AirCrashlytics.instance.start();

// Force a crash (iOS only)
AirCrashlytics.instance.crash();

// Set a user identifier
AirCrashlytics.instance.userIdentifier = "myUserIdentifier";

// Set some custom keys
AirCrashlytics.instance.setBool("myBoolKey", true);
AirCrashlytics.instance.setInt("myIntKey", 10);
AirCrashlytics.instance.setFloat("myFloatKey", 2.5);
AirCrashlytics.instance.setString("myStringKey", "myStringValue");

To receive symoblicated reports in your dashboard with iOS, you need to execute Fabric/upload-symbols after building your AIR application. You need to provide the path to your .dSYM file, so if you are compiling in release mode with Flash Builder be sure to check "Keep bin-release-temp folder" otherwise the .dSYM file will be deleted by Flash Builder:

cd /path/to/the/ane
.ios/Pods/Fabric/upload-symbols -a YOUR-API-KEY -p ios /path/to/your/dsym

Notes:

  • included binary has been compiled for 64-bit iOS support

Build from source

Should you need to edit the extension source code and/or recompile it, you will find an ant build script (build.xml) in the build folder:

cd /path/to/the/ane

# Setup build configuration
cd build
mv example.build.config build.config
# Edit build.config file to provide your machine-specific paths

# Build the ANE
ant

Authors

This ANE has been written by Alexis Taugeron and Mateo Kozomara. It belongs to FreshPlanet Inc. and is distributed under the Apache Licence, version 2.0.

Join the FreshPlanet team - GAME DEVELOPMENT in NYC

We are expanding our mobile engineering teams.

FreshPlanet is a NYC based mobile game development firm and we are looking for senior engineers to lead the development initiatives for one or more of our games/apps. We work in small teams (6-9) who have total product control. These teams consist of mobile engineers, UI/UX designers and product experts.

Please contact Tom Cassidy ([email protected]) or apply at http://freshplanet.com/jobs/