Bug Reporting and In-App Chat for Mobile Apps

For more info, visit Instabug.com.

Installation

CocoaPods

To integrate Instabug into your Xcode project using CocoaPods, add it to your Podfile:

pod 'Instabug'

Then, run the following command:

$ pod install

Manually

1. Download the Instabug SDK

2. Extract it then drag & drop the Instabug.framework and Instabug.bundle files to your project, and make sure that the "Copy items if needed" checkbox is checked.

3. Make sure your project links to the following system frameworks. You can add these under your project's Build Phases tab, under Link Binary With Libraries.

   • AVFoundation.framework
   • CoreGraphics.framework
   • CoreMotion.framework
   • CoreTelephony.framework
   • SystemConfiguration.framework
   • UIKit.framework
   • CoreMedia
   • CoreVideo

Dynamic Framework

Instabug Dynamic Framework

Usage

1. Import Instabug framework header in your app delegate

   // Swift
   import Instabug

   // Objective-C
   #import <Instabug/Instabug.h>

2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.

   // Swift
   Instabug.start(withToken: <#app token#>, invocationEvent: .shake)

   // Objective-C
   [Instabug startWithToken:<#app token#> invocationEvent:IBGInvocationEventShake];

   Make sure to replace app_token with your application token. Find it here.

Notes

Instabug needs access to the microphone and photo library. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.

For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:

• NSMicrophoneUsageDescription
• NSPhotoLibraryUsageDescription

If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:

• "<app name> needs access to the microphone to be able to attach voice notes."
• "<app name> needs access to your photo library for you to be able to attach images."

The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.

More

You can also check out our API Reference for more detailed information about our SDK.