Packagecom.adobe.ane.testFlight
Classpublic class TestFlight
InheritanceTestFlight Inheritance Object

This class is responsible for TestFlight integration in an application.

Many of these methods correspond to methods in the TestFlight SDK, so for complete information, see the TestFlight SDK Documentation page.



Public Properties
 PropertyDefined By
  isSupported : Boolean
[static] [read-only] Indicates whether the feature is supported on the underlying platform This method should be called before attempting to use any functionality related to the feature Currently, the feature is supported only in AIR on iOS.
TestFlight
Public Methods
 MethodDefined By
  
TestFlight(takeOffToken:String, setDeviceIdentifierToken:Boolean)
Creates a new TestFlight instance.
TestFlight
  
log(logStr:String):void
This method writes to the TestFlight log.
TestFlight
  
This method opens a default (also called "unguided") feedback view provided by TestFlight SDK.
TestFlight
  
passCheckPoint(checkPoint:String):void
This method checks whether or not a particular area of the code is being hit.
TestFlight
  
setOptions(options:Array):void
Use this method to set options supported by the TestFlight SDK.
TestFlight
  
submitCustomFeedBack(feedbackString:String):void
Use this method to provide feedback programmatically or by creating a custom view.
TestFlight
Property Detail
isSupportedproperty
isSupported:Boolean  [read-only]

Indicates whether the feature is supported on the underlying platform This method should be called before attempting to use any functionality related to the feature Currently, the feature is supported only in AIR on iOS.


Implementation
    public static function get isSupported():Boolean
Constructor Detail
TestFlight()Constructor
public function TestFlight(takeOffToken:String, setDeviceIdentifierToken:Boolean)

Creates a new TestFlight instance.

Checks whether TestFlight is supported on underlying platform or not (currently supported on iOS only). If TestFlight is supported, this calls the external takeOff method with takeOffToken and (if setDeviceIdentifier is true) calls the external setDeviceIdentifier method.

Parameters
takeOffToken:String — String that identifies and authenticates your app, provided by testFlight
 
setDeviceIdentifierToken:Boolean — Boolean that indicates whether to pass the device's identifier

Example
The following code snippet illustrates the use of the TestFlight constructor:
         ...
         import com.adobe.ane.testFlight.TestFlight;
         ...
         private var extension:TestFlight;
         ...
         extension= new TestFlight("long-alphanumeric-string",false);
         
Method Detail
log()method
public function log(logStr:String):void

This method writes to the TestFlight log. You can view these logs in the TestFlight web interface.

Parameters

logStr:String — String that contains the message to be logged.


Throws
ArgumentError — when the logStr parameter is null.
openFeedBackView()method 
public function openFeedBackView():void

This method opens a default (also called "unguided") feedback view provided by TestFlight SDK. Feedback submitted by this method can be seen in the TestFlight web interface.


Example
The following code snippet illustrates the use of this method:
         ...
         import com.adobe.ane.testFlight.TestFlight;
         ...
         private var extension:TestFlight;
         ...
         extension.openFeedBackView();
         
passCheckPoint()method 
public function passCheckPoint(checkPoint:String):void

This method checks whether or not a particular area of the code is being hit. You can use the TestFlight Web interface to associate questions with unique checkPoints.

Parameters

checkPoint:String — String that contains a meaningful identifier for the area of code that represents the checkpoint.


Example
The following code snippet illustrates the use of this method:
         ...
         import com.adobe.ane.testFlight.TestFlight;
         ...
         private var extension:TestFlight;
         ...
         extension.passCheckPoint("UserAuthenticationFailed");
         
setOptions()method 
public function setOptions(options:Array):void

Use this method to set options supported by the TestFlight SDK. objects and each object

Parameters

options:Array — An array of objects in which each object contains a key and and a value corresponding to that key. For example myObj.key = "logToConsole" and myObj.value = "NO".


Throws
ArgumentError — when the options parameter is null.

Example
The following code snippet illustrates the use of this method:
         ...
         import com.adobe.ane.testFlight.TestFlight;
         ...
         private var extension:TestFlight;
         ...
         var myObj1:Object = new Object();
         myObj1.key = "logToSTDERR";
         myObj1.value = "NO";
         
         var objArr1:Array = new Array();
         objArr1[0] = myObj1;
         extension.setOptions(objArr1);
         
submitCustomFeedBack()method 
public function submitCustomFeedBack(feedbackString:String):void

Use this method to provide feedback programmatically or by creating a custom view. Feedback submitted by this method can be seen in the TestFlight web interface.

Parameters

feedbackString:String — String that contains the feedback.


Throws
ArgumentError — when the feedbackString parameter is null.

Example
The following code snippet illustrates the use of this method:
         ...
         import com.adobe.ane.testFlight.TestFlight;
         ...
         private var extension:TestFlight;
         ...
         extension.submitCustomFeedBack(customfeedback.text);