Giter VIP home page Giter VIP logo

testflightplugin's Introduction

TestFlight Plugin for Apache Cordova

created by Shazron Abdullah

Apache 2.0 License except for the TestFlight SDK

Project includes;

  • iOS 2.2.3 SDK

  • Android 1.4 SDK

To add this plugin just type: cordova plugin add https://github.com/shazron/TestFlightPlugin.git

To remove this plugin type: cordova plugin remove com.testflightapp.cordova-plugin

The plugin's JavaScript functions are called after creating the plugin object thus:

    var tf = new TestFlight();
    tf.takeOff(win, fail, "some_app_token");

Make sure you create the object after the "deviceready" event has fired.

See the functions below (and the TestFlight SDK docs) for usage. Unfortunately all of TestFlight's SDK functions return void, and errors can only be gleaned from the run console, so check that for errors.

    // Get a reference to the plugin first
    var tf = new TestFlight();

    /*
     Add custom environment information
     If you want to track a user name from your application you can add it here
 
     @param successCallback function
     @param failureCallback function
     @param key string
     @param information string
     */
    tf.addCustomEnvironmentInformation(successCallback, failureCallback, 'key', 'information');

    /*
     Starts a TestFlight session
 
     @param successCallback function
     @param failureCallback function
     @param appToken string
     */
    tf.takeOff(successCallback, failureCallback, 'appToken');

    /*
     Sets custom options
 
     @param successCallback function
     @param failureCallback function
     @param options object i.e { reinstallCrashHandlers : true }
     */
    tf.setOptions(successCallback, failureCallback, options);

    /*
     Track when a user has passed a checkpoint after the flight has taken off. Eg. passed level 1, posted high score
 
     @param successCallback function
     @param failureCallback function
     @param checkpointName string
     */
    tf.passCheckpoint(successCallback, failureCallback, 'checkpointName');

    /*
     Send log message to testflight servers...
 
     @param successCallback function
     @param failureCallback function
     @param message string
     */
    tf.remoteLog(successCallback, failureCallback, 'message');

    /*
     Send log message to testflight servers... (async).
     Note that you might lose logs in a crash.
 
     @param successCallback function
     @param failureCallback function
     @param message string
     */
    tf.remoteLogAsync(successCallback, failureCallback, 'message');

    /*
      Submits custom feedback to the site. Sends the data in feedback to the site. 
      This is to be used as the method to submit feedback from custom feedback forms.
     
      @param successCallback function
      @param failureCallback function
      @param feedback Your users feedback, method does nothing if feedback is nil
    */
    tf.submitFeedback(successCallback, failureCallback, 'feedback');

    /*
     Manually start a session.
     
      @param successCallback function
      @param failureCallback function
    */
    tf.manuallyStartSession(successCallback, failureCallback);

    /*
      Manually end a session.
     
      @param successCallback function
      @param failureCallback function
    */
    tf.manuallyEndSession(successCallback, failureCallback);

testflightplugin's People

Contributors

shazron avatar dpogue avatar dabeck avatar jhurliman avatar isuda avatar j3k0 avatar jraleigh avatar jash avatar sydlawrencedev avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.