Apptentive iOS SDK

This iOS library allows you to add a quick and easy in-app-feedback mechanism to your iOS applications. Feedback is sent to the Apptentive web service.

Quickstart

There are no external dependencies for this SDK.

Sample Application

The sample application FeedbackDemo demonstrates how to integrate the SDK with your application.

Required Frameworks (Xcode 3 & 4)

In order to use ApptentiveConnect, your project must link against the following frameworks:

CoreGraphics
CoreTelephony
Foundation
QuartzCore
SystemConfiguration
UIKit

Project Settings for Xcode 4

There is a video demoing integration in Xcode 4 here: http://vimeo.com/23710908

Drag the ApptentiveConnect.xcodeproj project to your project in Xcode 4 and add it as a subproject. You can do the same with a workspace.

In your target's Build Settings section, add the following to your Other Linker Flags settings:

-ObjC -all_load

In your target's Build Phases section, add the ApptentiveConnect and ApptentiveResources targets to your Target Dependencies.

Then, add libApptentiveConnect.a to Link Binary With Libraries

Build the ApptentiveResources target for iOS devices. Then, add the ApptentiveResources.bundle from the ApptentiveConnect products in the file navigator into your Copy Bundle Resources build phase. Building for iOS devices first works around a bug in Xcode 4.

Now, drag ATConnect.h from ApptentiveConnect.xcodeproj to your app's file list.

That should be it!

Project Settings for Xcode 3

There is a video demoing integration in Xcode 3 here: http://vimeo.com/23566166

Drag the ApptentiveConnect.xcodeproj project to your project in Xcode.

In your build settings for All Configurations for your target, add the following to Other Linker Flags:

-ObjC -all_load

Inspect your application target by selecting the target and pressing Cmd+I, then in the General settings tab, add ApptentiveConnect and ApptentiveResources as direct dependencies.

Now, disclose the contents of the ApptentiveConnect.xcodeproj in Xcode and drag libApptentiveConnect.a to your target's Link Binary With Libraries build phase, and ApptentiveResources.bundle to your target's Copy Bundle Resources build phase.

Finally, drag ATConnect.h from ApptentiveConnect.xcodeproj to your app's file list.

That should be it!

Using the Library

ApptentiveConnect queues feedback and attempts to upload in the background. This is intended to provide as quick a mechanism for submitting feedback as possible.

In order for queued/interrupted feedback uploads to continue uploading, we recommending instantiating ATConnect and setting the API key at application startup, like:

#include "ATConnect.h"
// ...
- (void)applicationDidFinishLaunching:(UIApplication *)application /* ... */ {
    ATConnect *connection = [ATConnect sharedConnection];
    connection.apiKey = kApptentiveAPIKey;
    // ...
}

Where kApptentiveAPIKey is an NSString containing your API key. As soon as you set the API key on the shared connection object, any queued feedback will start to upload, pending network availability. You also should not have to set the API key again on the shared connection object.

Now, you can show the Apptentive feedback UI from a UIViewController with:

#include "ATConnect.h"
// ...
ATConnect *connection = [ATConnect sharedConnection];
[connection presentFeedbackControllerFromViewController:self];

Easy!

BUGS TO BE AWARE OF

Xcode 4 won't correctly rebuild static libraries inside a workspace when the source has changed. If you change the source of ApptentiveConnect when working on your app, you must do a Product > Clean before building and running your app.

Adding ATConnect.h to your project, above, is necessary due to a bug in Xcode 4 when archiving your app.

skyhigh / apptentive-ios