Integration for iOS

Download the latest version

Download v 2.0.2 Released: Oct 2, 2014

Requirements

UBERTESTERS FRAMEWORK

Requires iOS 5.1.1 or later. Compatible with iPhone, iPad, and iPod touch. This app is optimized for iPhone 5.

UBERTESTERS HUB

Requires iOS 6.0 or later. Compatible with iPhone, iPad, and iPod touch. This app is optimized for iPhone 5.

Release Notes

v. 2.0.1
  • Fixed the bug with the Ubertesters widget blocking the part of user interface in the default position.
v. 2.0.2
  • Added the new API [[Ubertesters shared] disableCrashHandler]; method
  • Renamed Ubertesters options for locking and activation mode
  • Ubertesters Project ID parameter is replaced with Ubertesters Organization SDK Token

Download the latest version of Ubertesters SDK for iOS

  1. Download ubertesters.sdk.ios.zip and unzip it
  2. Drag the UbertestersSDK folder to your project.
1

Add frameworks to your Link Binary With Libraries Build Phase tab.

Frameworks to be added:

  • AdSupport.framework,
  • QuartzCore.framework
  • CoreImage.framework,
  • SystemConfiguration.framework,
  • CoreTelephony.framework,
  • CoreLocation.framework.
  • AudioToolbox.framework.
  • OpenGLES.framework
  • CoreMotion.framework

  1. Select your Project in the Project Navigator
  2. Select the target you want to enable the SDK for
  3. Select the Build Phases tab
  4. Open the Link Binary With Libraries Phase
  5. Click the + to add a new library
  6. Find QuartzCore.framework in the list and add it
  7. Repeat Steps 2 – 6 until all targets you want to use the SDK with
2

Simply add pod 'Ubertesters' to your Podfile and run pod install You can then skip steps 1 throungh 2.

1-2

Add "Ubertesters Organization token" to your app's "Info.plist" file

  • 1.Open  http://beta.ubertesters.com/projects and select your project, go to SDK Integration
  • 2.Copy "Ubertesters Organization SDK Token"
    webprojectID
  • 3.Add "Ubertesters Organization SDK Token" to your app's "Info.plist" with the key "ubertesters_organization_token"
    projectIDinplist
3

Modify your Application Delegate file:

  1. Import Ubertesters:
    #import <UbertestersSDK/Ubertesters.h>

    HINT:

    Rather than importing Ubertesters.h in every file you may add the above line into your pre-compiled header (<projectname>_Prefix.pch) file inside of the #ifdef __OBJC__ section. It will give you access to the SDK across all files.

  2. Use Ubertesters Initialize function.
    -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:
        (NSDictionary *)launchOptions
    {
        //your code here
        ...
        //Ubertersters SDK initialization
        [[Ubertesters shared] initialize];
        return YES; // this is the rest of your method
    }
                                

It is possible to initialize Ubertesters in 2 ways:

  1. Using initializer with the default parameters.

    When you are using the initializer with the default parameters – UbertestersActivationModeWidget for activation mode and UbertestersLockingModeDisableUbertesters for locking mode:

    [[Ubertesters shared] initialize];
  2. Using customized initializer.

    (void)initializeWithOptions:(Ubertesters)options;

    Example:

    [[Ubertesters shared] initializeWithOptions:UbertestersActivationModeWidget
    UbertestersLockingModeDisableUbertesters];

    The customized initializer is used with the Ubertesters SDK options which determine the behavior of Ubertesters widget (with the help of which you call the bug submission screen) and the behavior of the Ubertesters app when the build/app is not available in Ubertesters system. According to their functions, all the options can be divided in two groups – activation mode options and locking mode options.

    You can use the following options for the customized initializer:

Activation mode options:

UbertestersActivationModeWidget The Ubertesters widget (an orange bubble) is shown, and you need to click on it to call a bug submission screen.
UbertestersActivationModeShake The widget is not shown, you need to shake your phone to call a menu for a bug submission or take a screenshot.
UbertestersActivationModeManual The Ubertesters widget is not shown, a menu should be called with the help of our API methods. You can specify the conditions under which the Ubertesters menu will be shown.

Locking mode options:

UbertestersLockingModeDisableUbertesters This option will not lock your application if the build is not uploaded on our server
UbertestersLockingModeLockApplication Ubertesters SDK locks the app completely if the build is not located on our server, it is impossible to navigate through the app

Additional option:

UbertestersDefault Combines two options: UbertestersActivationModeWidget and UbertestersLockingModeDisableUbertesters.

WARNING:

Make sure you are using Apple LLVN compiler 4.2 and greater. Go to BuildSettings of your target and find BuildOptions. There will be row Compiler for C/C++/Objective-C.

4

Ubertesters SDK API methods

API methods allow the developers to call additional methods and customize our SDK according to their needs.

Remote Logging

To perform remote logging you can use the UTLog method. UT log is a function with a text and a log level.

Remote logging allows you to send an important system event information to Ubertesters server dedicating to storing and archiving this data. You can check the sent logs in your Ubertesters account in Activity > Session > Session Tracking

UTLog methods:

UTLogLevelInfo Sends info logs
UTLogLevelWar Sends warning logs
UTLogLevelError Sends error logs

To add UTLog, please use the following line:

- (void)UTLog:(NSString *)format withLevel:(UTLogLevel)level
typedef enum
{
    UTLogLevelError, // level = «error»
    UTLogLevelWarning, // level = «warning»
    UTLogLevelInfo // level = «info»
} UTLogLevel;
        

Example:

[[Ubertesters shared] UTLog:@“text message” withLevel:UTLogLevelInfo];

API methods used with UbertestersActivationModeManual

These methods allow to specify the behavior of Ubertesters bug submission screen in case Manual mode is used.

Method Action Example
- (void)makeScreenshot; Captures screenshot in the app you are testing [[Ubertesters shared] makeScreenshot];
- (void)showMenu; Shows Ubertesters menu [[Ubertesters shared] showMenu];
- (void)hideMenu; Shows Ubertesters menu [[Ubertesters shared] hideMenu];

Disable Crash Handler

Method Action
- (void) disableCrashHandler; Disables Ubertesters crash handler. Allows using our platform along with third party crash reporters.

Example:

[[Ubertesters shared] disableCrashHandler];

Ubertesters Extra Data protocol

Method Action
ubertestersIssueWillPost Allows the developer to add extra data parameters to the reports sent to the server when the issue is reported.
5